Commit Graph

9 Commits (0918efd02d2ebe161d4170cb37eb505c6b73d535)

Author SHA1 Message Date
PeridexisErrant cfc322fb7f Improve handling of in-script documentation
Closes issue #823.  This allows for clean unification of html docs and
the in-terminal help text for scripts, including handling in core rather
than on a per-script basis (see issue #947).
2016-06-15 18:28:54 +10:00
lethosor 022a1bf9e8 Wrap script descriptions in `ls` output and remove description length cap 2016-06-14 21:24:27 -04:00
PeridexisErrant 205e5cd371 Un-break script doc checker
This handles any number of empty lines above the title, including zero -
a harmless case which was breaking the build.
2016-04-15 16:51:24 +10:00
PeridexisErrant feff83cedc Require a short help string for "ls"
The linter change will enforce it for scripts.  Plugins always include
the line, and length will have to be checked manually.
2016-04-15 16:28:41 +10:00
lethosor 6637a85164 Don't hardcode line numbers in script documentation check 2015-12-28 16:31:36 -05:00
PeridexisErrant 4cdfcbaa9b Linting: improve script docs check, work off Travis
Expands coverage of scripts linting, and improves checks for a correct
title.  Various fixes to make 'python travis/all.py' work for offline
users; when the TRAVIS envvar is not set it now fails without an error.

Minor cleanup in conf.py
2015-11-06 10:15:19 +11:00
PeridexisErrant a37ae8dbd2 Improve travis checks for branch, script docs
The change to pr-check-base avoids failing builds which should pass
because the GH API is limited.  It'll still work almost all of the time,
but no longer fail builds which previously passed and then pushed more
commits.  Closes #694.
2015-10-28 10:07:02 +11:00
PeridexisErrant 54f3c6a138 Updated docs linter for scripts
Also made scripts toctree more explicit
2015-10-24 17:00:54 +11:00
PeridexisErrant 8661f5dc4f Add linter to check scripts are in readme, pass it
We knew a fair few were missing, but this was more than I expected.
2015-09-23 15:25:41 +10:00