@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
Fix line lengths in documentation and lint `*.book` files as JSON.
Summary: Fix a few "line too long" lint issues in the Diviner documentation. Also lint `*.book` files as JSON.
Test Plan: Eye-ball it.
Reviewers: epriestley, #blessed_reviewers
Reviewed By: epriestley, #blessed_reviewers
Subscribers: epriestley, Korvin
Differential Revision: https://secure.phabricator.com/D9695
+13
-9
+1
.arclint
+1
.arclint
+2
-1
src/docs/contributor/general_coding_standards.diviner
+2
-1
src/docs/contributor/general_coding_standards.diviner
···
69
69
- Follow language-specific conventions.
70
70
- Name things unambiguously.
71
71
- Choose descriptive names.
72
-
- Avoid nonstandard abbreviations (common abbreviations like ID, URI and HTTP are fine).
72
+
- Avoid nonstandard abbreviations (common abbreviations like ID, URI and HTTP
73
+
are fine).
73
74
- Spell words correctly.
74
75
- Use correct grammar.
75
76
+2
-1
src/docs/contributor/php_coding_standards.diviner
+2
-1
src/docs/contributor/php_coding_standards.diviner
···
1
1
@title PHP Coding Standards
2
2
@group standards
3
3
4
-
This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil).
4
+
This document describes PHP coding standards for Phabricator and related
5
+
projects (like Arcanist and libphutil).
5
6
6
7
= Overview =
7
8
+2
-2
src/docs/flavor/writing_reviewable_code.diviner
+2
-2
src/docs/flavor/writing_reviewable_code.diviner
···
79
79
80
80
= Write Sensible Commit Messages =
81
81
82
-
There are lots of resources for this on the internet. All of them say pretty much
83
-
the same thing; this one does too.
82
+
There are lots of resources for this on the internet. All of them say pretty
83
+
much the same thing; this one does too.
84
84
85
85
The single most important thing is: **commit messages should explain //why// you
86
86
are making the change**.
+3
-2
src/docs/user/userguide/arcanist_lint_unit.diviner
+3
-2
src/docs/user/userguide/arcanist_lint_unit.diviner
···
37
37
= Create a libphutil Library =
38
38
39
39
If you haven't created a library for the class to live in yet, you need to do
40
-
that first. Follow the instructions in @{article:libphutil Libraries User Guide},
41
-
then make the library loadable by adding it to your ##.arcconfig## like this:
40
+
that first. Follow the instructions in
41
+
@{article:libphutil Libraries User Guide}, then make the library loadable by
42
+
adding it to your ##.arcconfig## like this:
42
43
43
44
{
44
45
// ...
+3
-3
src/docs/user/userguide/diviner.diviner
+3
-3
src/docs/user/userguide/diviner.diviner
···
45
45
46
46
The properties in this file are:
47
47
48
-
- `name`: Required. Short, unique name to identify the documentation book. This
49
-
will be used in URIs, so it should not have special characters. Good names
50
-
are things like `"example"` or `"libcabin"`.
48
+
- `name`: Required. Short, unique name to identify the documentation book.
49
+
This will be used in URIs, so it should not have special characters. Good
50
+
names are things like `"example"` or `"libcabin"`.
51
51
- `root`: Required. The root directory (relative to the `.book` file) which
52
52
documentation should be generated from. Often this will be a value like
53
53
`"../../"`, to specify the project root (for example, if the `.book` file