@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Update symbols docs
Summary: Update manual to reflect T7984 and T8302.
Test Plan: Not many new red squigly lines.
Reviewers: joshuaspence, epriestley, #blessed_reviewers
Reviewed By: joshuaspence, epriestley, #blessed_reviewers
Subscribers: epriestley, Korvin
Differential Revision: https://secure.phabricator.com/D13551
authored by
Aviv Eyal
and committed by
epriestley
99fd5e99
b36d4025
+15
-8
+15
-8
src/docs/user/userguide/diffusion_symbols.diviner
+15
-8
src/docs/user/userguide/diffusion_symbols.diviner
···
9
9
and functions are defined in the codebase. Once you set up indexing, you can
10
10
use the index to do things like:
11
11
12
-
- link symbol uses in Differential code reviews and Diffusion code browsing
13
-
to their definitions
14
-
- allow you to search for symbols
12
+
- jump to symbol definitions from Differential code reviews and Diffusion
13
+
code browsing by ctrl-clicking (cmd-click on Mac) symbols
14
+
- search for symbols from the quick-search
15
15
- let the IRC bot answer questions like "Where is SomeClass?"
16
16
17
-
NOTE: Symbol indexing is somewhat new, and has broader support for PHP than for
18
-
other languages.
17
+
NOTE: Because this feature depends on the syntax highlighter, it will work
18
+
better for some languages than others. It currently works fairly well for PHP,
19
+
but your mileage may vary for other languages.
19
20
20
21
= Populating the Index =
21
22
···
85
86
Phabricator lists "Arcanist" and "libphutil" because it uses classes and
86
87
functions from these repositories.
87
88
88
-
NOTE: Because this feature depends on the syntax highlighter, it will work
89
-
better for some languages than others. It currently works fairly well for PHP,
90
-
but your mileage may vary for other languages.
89
+
== External Symbols ==
90
+
91
+
By @{article:Adding New Classes}, you can teach Phabricator
92
+
about symbols from the outside world.
93
+
Extend @{class:DiffusionExternalSymbolsSource}; Once loaded, your new
94
+
implementation will be used any time a symbol is queried.
95
+
96
+
See @{class:DiffusionPhpExternalSymbolsSource} and
97
+
@{class:DiffusionPythonExternalSymbolsSource} for example implementations.