a new way to do python code documentation
Project description
archives is a new style of python code documentation, as well as a linter for the documentation itself. It can help you ensure that your docstrings in your classes and functions stay up to date, and that they adequately explain their purpose, arguments, and return value.
Features
linter for docstrings (work in progress, but usable)
(coming soon) documentation generator
Usage
Installation
pip install archivesRun the Linter
# run archives (on itself!)
archives archives.py
#> archives.py:846:0: F104 function 'path_empty' missing @ret tag
#>
#> Impossible! Perhaps your archives are incomplete?
#> 1 issues found.
# list rules!
archives --list-rules
# disable rules!
archives --disable M100 .
# different formats for output! defaults to flake8
archives --format pylint archives.pyTesting
Tests can be run with tox!
# run tests
tox
# only one version of python
tox -e py36Todo
more rules
better system for multi-check rules
more output formats
potentially spell-checking inside desc?
documentation generator
tests
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
archives-0.7.tar.gz
(10.6 kB
view details)
File details
Details for the file archives-0.7.tar.gz.
File metadata
- Download URL: archives-0.7.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5d309b495b4733d761bc204a5d9d03ea274a58b26686d35d69c570c0309feb53 |
|
| MD5 | eeeb69f70cd6fc95b804110064b68368 |
|
| BLAKE2b-256 | 66baefc48dbf0692718793de22d3ca5b201b5733c6b962bb7c7166706b3a3a56 |
