Implement documentation linting #1854
Conversation
| @@ -15,11 +15,13 @@ def onClick(self, _): | |||
|
|
|||
|
|
|||
| class PickerBase(Widget, ABC): | |||
| @abstractclassmethod | |||
There was a problem hiding this comment.
abstractclassmethod was deprecated a long time ago.
| @@ -208,8 +208,6 @@ class CGEventRef(c_void_p): | |||
| kCGImageAlphaNoneSkipFirst = 6 | |||
| kCGImageAlphaOnly = 7 | |||
|
|
|||
| kCGImageAlphaPremultipliedLast = 1 | |||
There was a problem hiding this comment.
since it may not be clear....this was already initialized above.
- Introduce new tox environments `docs-lint` and `docs-all` - `docs-lint` will check for dead links and run spellchecking - `docs-all` will force a rebuild for all documentation - Update documentation and docstrings to pass linting; this includes some innocuous code changes for modernization - Run `tox -e docs-lint` on RTD before the docs are built
There was a problem hiding this comment.
This looks good for the most part; The only comment I've got is the list of terms in the spelling list. That list shouldn't contain any examples of:
- code-specific terms (e.g.,
endAngle), or - non-US spelling (e.g., initialised).
Code terms should be quoted as literals in the docs for rendering purposes; this also means they won't be considered for spelling.
As for the UK/AU spelling - for the sake of consistency and avoiding the inevitable "you spelled colour wrong" pull requests, we should converge on US spelling.
I've corrected these; so we should be good to go!
|
RE: UK/AU spelling I was actually surprised by PyCharm with this...it detected that a previous form of the word matched UK/AU spelling and suggested being consistent....I was mildly impressed and surprised by that. Additionally, I commonly find myself google searching certain spellings because I'm not sure if it's misspelled.....or spelled differently elsewhere 😆 |
Changes
docs-lintanddocs-alldocs-lintwill check for dead links and run spellcheckingdocs-allwill force a rebuild for all documentationtox -e docs-linton RTD before the docs are builtNotes
-j autoswitch cannot be used for multiprocessing;crate.sphinx.csvdoesn't support it....or at least doesn't explicitly say it's supported.-ncannot be used because of several issues with references.toga.Apptotoga.app.App; sphinx needs the canonical path.nitpick errors:
PR Checklist: