Page MenuHomePhabricator

Further modernize lint documentation
ClosedPublic

Authored by epriestley on May 12 2014, 1:37 AM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Dec 26, 6:56 PM
Unknown Object (File)
Thu, Dec 26, 2:34 PM
Unknown Object (File)
Mon, Dec 23, 4:32 AM
Unknown Object (File)
Thu, Dec 12, 4:05 AM
Unknown Object (File)
Sat, Dec 7, 8:02 AM
Unknown Object (File)
Nov 26 2024, 6:56 PM
Unknown Object (File)
Nov 25 2024, 9:05 AM
Unknown Object (File)
Nov 21 2024, 9:43 AM
Subscribers

Details

Reviewers
joshuaspence
btrahan
avive
Maniphest Tasks
Restricted Maniphest Task
Commits
Restricted Diffusion Commit
rP94772689cd31: Further modernize lint documentation
Summary

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

Test Plan

Generated and read documentation.

Diff Detail

Repository
rP Phabricator
Branch
ldocs
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 375
Build 375: [Placeholder Plan] Wait for 30 Seconds

Event Timeline

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.

joshuaspence edited edge metadata.

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.

epriestley edited edge metadata.
  • Be more clear that keys are human-readable.
  • Be more clear about regexp formats.
  • Mention that "most" (not "all") linters support "severity".
  • Specify arc linters --verbose as the way to get full options (see D9062).
This revision is now accepted and ready to land.May 12 2014, 2:47 AM
epriestley updated this revision to Diff 21542.

Closed by commit rP94772689cd31 (authored by @epriestley).