Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve ReadMe #139

Open
4 tasks
maxbachmann opened this issue Oct 1, 2021 · 0 comments
Open
4 tasks

Improve ReadMe #139

maxbachmann opened this issue Oct 1, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@maxbachmann
Copy link
Member

The current readme does not reflect many of the most recent changes. It would make sense to update it accordingly:

  • From the current readme it appears like rapidfuzz is a replacement for fuzzywuzzy. However rapidfuzz provides a growing number of features which are not supported by fuzzywuzzy like
    • more string metrics (e.g. levenshtein/hamming/jaro/jaro winkler
    • cdist
    • multithreading
      This should both be visible in the Description and in the Usage section
  • The readme mentions installation from pip/conda/git. It would probably be enough to mention the installation via pip, since it is the most used version. For other versions the documentation could be referenced: https://maxbachmann.github.io/RapidFuzz/installation.html
  • The usage section is relatively useless so far, since it only shows some arbitrary api calls without any explanation
  • The benchmark section does not show very useful results, since it only shows a comparision between rapidfuzz and fuzzywuzzy for some arbitrary string lengths. I am not sure yet how to make this more usefull. Detailed benchmarks of each function are already included in the documentation.
@maxbachmann maxbachmann added documentation Improvements or additions to documentation hacktoberfest labels Oct 1, 2021
@maxbachmann maxbachmann added help wanted Extra attention is needed and removed hacktoberfest labels Nov 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant