1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-18 19:40:55 +01:00

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
This commit is contained in:
Joshua Spence 2014-06-24 04:26:06 +10:00
parent 21a2597421
commit 464979302b
6 changed files with 13 additions and 9 deletions

View file

@ -32,6 +32,7 @@
"json": { "json": {
"type": "json", "type": "json",
"include": [ "include": [
"(^src/docs/book/.*\\.book$)",
"(^support/jshint/jshintconfig$)", "(^support/jshint/jshintconfig$)",
"(^\\.arcconfig$)", "(^\\.arcconfig$)",
"(^\\.arclint$)", "(^\\.arclint$)",

View file

@ -69,7 +69,8 @@ gather concrete performance data.
- Follow language-specific conventions. - Follow language-specific conventions.
- Name things unambiguously. - Name things unambiguously.
- Choose descriptive names. - Choose descriptive names.
- Avoid nonstandard abbreviations (common abbreviations like ID, URI and HTTP are fine). - Avoid nonstandard abbreviations (common abbreviations like ID, URI and HTTP
are fine).
- Spell words correctly. - Spell words correctly.
- Use correct grammar. - Use correct grammar.

View file

@ -1,7 +1,8 @@
@title PHP Coding Standards @title PHP Coding Standards
@group standards @group standards
This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil). This document describes PHP coding standards for Phabricator and related
projects (like Arcanist and libphutil).
= Overview = = Overview =

View file

@ -79,8 +79,8 @@ reviewing big checkins.
= Write Sensible Commit Messages = = Write Sensible Commit Messages =
There are lots of resources for this on the internet. All of them say pretty much There are lots of resources for this on the internet. All of them say pretty
the same thing; this one does too. much the same thing; this one does too.
The single most important thing is: **commit messages should explain //why// you The single most important thing is: **commit messages should explain //why// you
are making the change**. are making the change**.

View file

@ -37,8 +37,9 @@ make this work, you need to do three things:
= Create a libphutil Library = = Create a libphutil Library =
If you haven't created a library for the class to live in yet, you need to do If you haven't created a library for the class to live in yet, you need to do
that first. Follow the instructions in @{article:libphutil Libraries User Guide}, that first. Follow the instructions in
then make the library loadable by adding it to your ##.arcconfig## like this: @{article:libphutil Libraries User Guide}, then make the library loadable by
adding it to your ##.arcconfig## like this:
{ {
// ... // ...

View file

@ -45,9 +45,9 @@ look like this:
The properties in this file are: The properties in this file are:
- `name`: Required. Short, unique name to identify the documentation book. This - `name`: Required. Short, unique name to identify the documentation book.
will be used in URIs, so it should not have special characters. Good names This will be used in URIs, so it should not have special characters. Good
are things like `"example"` or `"libcabin"`. names are things like `"example"` or `"libcabin"`.
- `root`: Required. The root directory (relative to the `.book` file) which - `root`: Required. The root directory (relative to the `.book` file) which
documentation should be generated from. Often this will be a value like documentation should be generated from. Often this will be a value like
`"../../"`, to specify the project root (for example, if the `.book` file `"../../"`, to specify the project root (for example, if the `.book` file