darglint2
darglint2 copied to clipboard
akaihola
A python documentation linter which checks that the docstring description matches the definition. Based on darglint by @terrencepreilly.
See terrencepreilly/darglint#177 for some observations from @felixvd.
Includes `Bug Report`, `Bug Report Form`, `Feature Request` and a PR template. This is still a draft since other part of the documentation have to be finished before the templates...
Fixes #3 partially. Bringing in the Wiki documents and images from the [Design](/terrencepreilly/darglint/wiki/Design) section of the original Darglint wiki. To do: - [ ] move the documents to the `docs/`...
Eventually I'd prefer `monospace` to be used in most places where _italics_ is now used – at least for directory paths and file names, command lines and format string attributes....
There are some technical terms we use or should use consistently throughout the documentation.
At the moment arguments have to be 'defined' in multiple places for parsing from different configuration files and such. I saw people extending argparse to define config options in one...
- [x] Issue templates - [x] Bug - [x] FR - [x] PR templates The templates should guide people into submitting well-formatted and valuable reports containing all information needed.
I would like to improve our community standards by adding the following. Feel free to add stuff or tell me if you don't like something. We will definitely have to...
_Originally posted by @real-yfprojects in https://github.com/akaihola/darglint2/issues/10#issuecomment-1437500527_
### Background - `doc_extract -s repos.txt -o docstrings.json` accepts local Git repo paths in `repos.txt` and writes docstrings and metadata into `docstrings.json`. - The Elm webapp accepts `docstrings.json` and lets...