search

Martinsos / edlib

Lightweight, super fast C/C++ (& Python) library for sequence alignment using edit (Levenshtein) distance.
http://martinsos.github.io/edlib
MIT License
493 stars 162 forks source link

Feature/improve python readme #139

Closed evanbiederstedt closed 4 years ago

evanbiederstedt commented 4 years ago

Revised the README to make things more clear---I felt this was needed after confusing myself with the python API.

There were also a few spelling corrections, as well as additions to the edlib.pyx comments.

@Martinsos, please feel free to edit this PR as you wish, and edit the changes I made here---I'm not picky :)

Thanks, Evan

Martinsos commented 4 years ago

Will take a look at this soon, sorry for not doing it sooner! And while at it, we should also make sure to document for python package the support for sequences of hashable objects, that is not stated anywhere right except in the function header.

evanbiederstedt commented 4 years ago

Hi @Martinsos

we should also make sure to document for python package the support for sequences of hashable objects, that is not stated anywhere right except in the function header.

This is a good point! And I've done this here.

I do think maybe we could give a better example to users as to want bytes and hashable objects are accepted.

Please make any changes to the documentation you see fit, and accept the PR---I think that's the best way forward :)

I simply wanted a bit better documentation for a few things, as I found this confusing. I think I accomplished that, so please edit as you wish.

Martinsos commented 4 years ago

@evanbiederstedt , I will be closing this PR, but I opened another one (https://github.com/Martinsos/edlib/pull/143) where I transfered all your commits + added some of mine own. Main difference is that README.rst is now auto-generated, and all code examples are actually evaluated based on the current edlib python code, including the help docs for specific methods. This means that README.rst never gets outdated! README-tmpl.rst is now source, while README.rst is not tracked in git anymore since it is generated. Feel free to comment on that PR, I plan to merge it once CI goes through.