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.

Sign up for GitHub

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

Jump to bottom

Documentation improvement #189

Open
anomitra opened this issue Dec 9, 2017 · 5 comments · May be fixed by #258
Open

Documentation improvement #189

anomitra opened this issue Dec 9, 2017 · 5 comments · May be fixed by #258

Comments

@anomitra
Copy link

anomitra commented Dec 9, 2017

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
Copy link
Contributor

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

@Shellcat-Zero
Copy link

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
Copy link
Contributor

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 pushed a commit to heitorPB/fuzzywuzzy that referenced this issue Jan 8, 2020
Initial sphinx documentation
3601277 
fix seatgeek#189
@heitorPB heitorPB linked a pull request Jan 8, 2020 that will close this issue
Open
@heitorPB
Copy link

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

@josegonzalez
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Initial sphinx documentation heitorPB/fuzzywuzzy
4 participants
@josegonzalez @anomitra @Shellcat-Zero @heitorPB