Skip to content

Commit 77fa7c8

Browse files
committed
Docs - expand documentation on custom fields for selects a bit
Summary: ...and fix an error where lines that start with ##X## are rendering incorrectly by switching to alternate syntax `X`. Fixes T5806. Test Plan: read the docs and they looked good Reviewers: epriestley Reviewed By: epriestley Subscribers: epriestley, Korvin Maniphest Tasks: T5806 Differential Revision: https://secure.phabricator.com/D10165
1 parent 20a65b2 commit 77fa7c8

18 files changed

+38
-30
lines changed

src/docs/contributor/javascript_coding_standards.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ see @{article:Javascript Object and Array}.
107107
break;
108108
}
109109

110-
##break## statements should be indented to block level. If you don't push them
110+
`break` statements should be indented to block level. If you don't push them
111111
in, you end up with an inconsistent rule for conditional ##break## statements,
112112
as in the ##2## case.
113113

src/docs/contributor/php_coding_standards.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ visually and react better to "Find Next..." in editors.
112112
break;
113113
}
114114

115-
##break## statements should be indented to block level.
115+
`break` statements should be indented to block level.
116116

117117
**array literals:**
118118

src/docs/contributor/using_oauthserver.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ How to use the Phabricator OAuth Server.
66
= Overview =
77

88
Phabricator includes an OAuth Server which supports the
9-
##Authorization Code Grant## flow as described in the OAuth 2.0
9+
`Authorization Code Grant` flow as described in the OAuth 2.0
1010
specification:
1111

1212
http://tools.ietf.org/html/draft-ietf-oauth-v2-23

src/docs/flavor/javascript_pitfalls.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ usually after operators.
2929

3030
= ##with## is Bad News =
3131

32-
##with## is a pretty bad feature, for this reason among others:
32+
`with` is a pretty bad feature, for this reason among others:
3333

3434
with (object) {
3535
property = 3; // Might be on object, might be on window: who knows.

src/docs/flavor/php_pitfalls.diviner

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,13 @@ Strongly prefer the ##key## varieties.
153153
= array_uintersect() and array_udiff() are Definitely Slow Too =
154154

155155
These functions have the problems of both the ##usort()## family and the
156-
##array_diff()## family. Avoid them.
156+
`array_diff()` family. Avoid them.
157157

158158
= foreach() Does Not Create Scope =
159159

160160
Variables survive outside of the scope of foreach(). More problematically,
161161
references survive outside of the scope of foreach(). This code mutates
162-
##$array## because the reference leaks from the first loop to the second:
162+
`$array` because the reference leaks from the first loop to the second:
163163

164164
COUNTEREXAMPLE
165165
$array = range(1, 3);
@@ -276,7 +276,7 @@ This doesn't do what you'd expect it to do in C:
276276

277277
This is because the successor to 'z' is 'aa', which is "less than" 'z'. The
278278
loop will run for ~700 iterations until it reaches 'zz' and terminates. That is,
279-
##$c## will take on these values:
279+
`$c` will take on these values:
280280

281281
a
282282
b

src/docs/tech/celerity.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ appropriate references to CSS and JS resources. It uses
4646
resources (so you only have to explicitly include what you're actually using,
4747
and not all of its dependencies) and any packaging rules (so it may be able to
4848
generate fewer resource requests, improving performance). It then generates
49-
##<script />## and ##<link />## references to these resources.
49+
`<script />` and `<link />` references to these resources.
5050

5151
These references point at ##/res/## URIs, which are handled by
5252
@{class:CelerityResourceController}. It responds to these requests and delivers

src/docs/tech/chatbot.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ servers and in different languages.
6767

6868
To allow the bot to access Conduit, you need to create a user that it can login
6969
with. To do this, login to Phabricator as an administrator and go to
70-
##People -> Create New Account##. Create a new account and flag them as a
70+
`People -> Create New Account`. Create a new account and flag them as a
7171
"Bot/Script". Then in your configuration file, set these parameters:
7272

7373
- ##conduit.uri## The URI for your Phabricator install, like

src/docs/tech/conduit.diviner

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ handles.
4444

4545
There is a web interface for viewing and testing Conduit called the "Conduit
4646
Console", implemented by @{class:PhabricatorConduitConsoleController} at
47-
##/conduit/##.
47+
`/conduit/`.
4848

4949
A log of connections and calls is stored by
5050
@{class:PhabricatorConduitConnectionLog} and
5151
@{class:PhabricatorConduitMethodCallLog}, and can be accessed on the web via
5252
@{class:PhabricatorConduitLogController} at ##/conduit/log/##.
5353

5454
Conduit provides a token-based handshake mechanism used by
55-
##arc install-certificate## at ##/conduit/token/##, implemented by
55+
`arc install-certificate` at `/conduit/token/`, implemented by
5656
@{class:PhabricatorConduitTokenController} which stores generated tokens using
5757
@{class:PhabricatorConduitCertificateToken}.

src/docs/tech/files.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ order to make files actually get written to it, you also need to extend
3636
@{class:PhabricatorFileStorageEngineSelector}, provide an implementation which
3737
selects your storage engine for whatever files you want to store there, and then
3838
configure Phabricator to use your selector by setting
39-
##storage.engine-selector##.
39+
`storage.engine-selector`.

src/docs/user/configuration/configuring_accounts_and_registration.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ administrative user.
4444
= Managing Accounts with the Web Console =
4545

4646
To manage accounts from the web, login as an administrator account and go to
47-
##/people/## or click "People" on the homepage. Provided you're an admin,
47+
`/people/` or click "People" on the homepage. Provided you're an admin,
4848
you'll see options to create or edit accounts.
4949

5050
= Manually Creating New Accounts =

0 commit comments

Comments
 (0)