Further modernize lint documentation
ClosedPublic
Actions

Authored by epriestley on May 12 2014, 1:37 AM.

Details

Reviewers

Maniphest Tasks

Restricted Maniphest Task

Commits

Summary

Ref T2039. Contains a small amount of wishful thinking, I'll note it inline.

Test Plan

Generated and read documentation.

Repository

rP Phabricator

Lint

Lint Skipped

Unit

Tests Skipped

epriestley retitled this revision from to Further modernize lint documentation.

epriestley updated this object.

epriestley edited the test plan for this revision. (Show Details)

epriestley added a task: Restricted Maniphest Task.

src/docs/user/userguide/arcanist_lint.diviner
58–59	This document is not very helpful for writing bindings, but we don't currently have a better one.
245–247	This is wishful thinking, but I'll make it happen shortly.
277–279	I'll actually create this shortly.

Just a few minor inlines.

src/docs/user/userguide/arcanist_lint.diviner
104	The name of the linter ("sample") doesn't really matter, at least for now. Maybe specify this so that it is clear ("The linter name doesn't matter, so choose something that makes sense to you".)
112	Not related to this specifically, but why do the regular expressions need to be surrounded by parentheses?

This revision now requires changes to proceed.May 12 2014, 1:46 AM

src/docs/user/userguide/arcanist_lint.diviner
112	They need to be full regular expressions with flags. You can use "/", but then you have to escape all the slashes in paths. So these are equivalent: "/path\\/to\\/stuff/i" "(path/to/stuff)i" The latter is just easier to read. I'll note this explicitly, though.