search

WojciechMula / pyahocorasick

Python module (C extension and plain python) implementing Aho-Corasick algorithm
BSD 3-Clause "New" or "Revised" License
927 stars 122 forks source link

Documentation enhancement #99

Closed WojciechMula closed 5 years ago

WojciechMula commented 5 years ago

While the current documentation is not bad, I'd call it sparse.

There's need to write rather detailed description of each method. The funny fact is that inline docs are more detailed than README entries. It would be great if we keep in sync inline and README description.

WojciechMula commented 5 years ago

My idea is to prepare restructuredText entries in separate files for each method. Such file should contain not only description but also examples.

The files are meant to be included directly into master .rst file, to make them nicely rendered at least on readthedocs.io (if it was possible, not to screw github preview).

The files will be automatically converted into plain text, and then into C-friendly string to include directly in module code.

WojciechMula commented 5 years ago

The inline documentation is generated from online one.