doc spell
Code documentation spell checker.
Retrieve human text from the code and pipe it to spell checker
The flow:
- collect all comments and doc strings
- strip technical text from comments
- fenced block - multi-line text between 3 back ticks, similar to
<pre>tag - in-line code - text between back ticks, similar to
<code> - special comment - e.g.
noqa,pylint
- fenced block - multi-line text between 3 back ticks, similar to
- feed it to spell checker
Installation
pip install doc-spell
1 maintainer
Release files for doc-spell 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| doc_spell-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / doc_spell-0.2.0-py3-none-any.whl
| Download URL | doc_spell-0.2.0-py3-none-any.whl |
|---|---|
| Size | 9.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0fc9115b991e5d2895fb6a5ce5c8fbf32c340b12cf4f9633c179bf968e9138a0
|
|
BLAKE2b-256 checksum How to use checksums |
b2a3db9cc5cb3c2cd897ab42d789398dd2448075c22b3e942c203dceb91649b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.7.4 CPython/3.11.4
|
