search

ztane / python-Levenshtein

The Levenshtein Python C extension module contains functions for fast computation of Levenshtein distance and string similarity
GNU General Public License v2.0
1.26k stars 155 forks source link

Feature Request - Documentation on Release #12

Closed daryltucker closed 9 years ago

daryltucker commented 10 years ago

Would you mind providing the HTML docs that can be generated?

It'd be very nice in deciding whether or not this is a library with which I (or others) would like to work.

Thanks.

fake-name commented 9 years ago

I generated the docs, and stuck them in the wiki.

They really should be more available, or even in the repo, though.

ztane commented 9 years ago

Now available in the repo, linked from readme.rst, and always available in pydoc.

fake-name commented 9 years ago

It might be a good idea to hook something like TravisCI into the system, to keep the docs up to date.

You can push build artifacts out of TravisCI at this point.

For that matter, unit testing would be nice too, though this library seems pretty stable at this point.

Realistically, as long as the docs are rebuilt when the codebase is updated, managing them manually will probably be completely sufficient.

ztane commented 9 years ago

There is no such thing as stable for this, as the Python 3 is not rigorously tested in real use, and the Python 2 side had a serious bug lurking since the beginning of the commit history (#8); and every change how minuscule that is needs to be verified for both Python 2 and 3... In Python 3.4 at least it is possible to easily run doctests from extension modules.