doc-spell 0.2.0

code documentation spell checker

doc spell

Code documentation spell checker.

Retrieve human text from the code and pipe it to spell checker

The flow:

1. collect all comments and doc strings
2. 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
3. feed it to spell checker

Installation

pip install doc-spell