Documentation improvement

[anomitra]

I was looking for a process function which would return the best x matches above a certain score cutoff. After some amount of searching and scrolling through the source code, I found extractBests which (almost) does what I want it to.

Is there a specific reason why extractBests is not mentioned in the documentation?

[josegonzalez]

No reason, it was probably pulled out in a refactor. If you want to document it, that would be great.

[Shellcat-Zero]

Is there a reason that an official API documentation page does not exist for fuzzywuzzy? I was unable to find API documentation from the blog that is linked on this Github page. For a project as well known and widely used as this, I was fully expecting a Python Read-the-Docs page to exist for it. If you have your docstrings properly set up in your source code, then you should be able to mostly auto-generate your documentation from your source code. Do you need someone to take on this task, or is it something that is already under way?

[josegonzalez]

This is not underway. The current documentation is setup in the readme. If you want to help get Sphinx docs setup, feel free to make a pull request and I can take care of the RTD end.

[heitorPB]

#258 starts the documentation using Sphinx. @josegonzalez are you still interested in adding RTD integration?

[josegonzalez]

I don't currently work at SeatGeek, though maybe someone will work on this in the next few weeks?