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

Fix mistakes in rapidfuzz.process docs #321

Merged
merged 3 commits into from
Apr 27, 2023

Conversation

boolean5
Copy link
Contributor

Hello,

As I was reading a part of the documentation I stumbled upon a couple of minor mistakes and this is a PR to fix them. You can find a detailed description in the commit messages.

Also, are these 3 references to max outdated?
https://github.com/maxbachmann/RapidFuzz/blob/c8be9093320bedcd1d75a816b6a554233074db78/src/rapidfuzz/process_py.py#L125
https://github.com/maxbachmann/RapidFuzz/blob/c8be9093320bedcd1d75a816b6a554233074db78/src/rapidfuzz/process_py.py#L467
https://github.com/maxbachmann/RapidFuzz/blob/c8be9093320bedcd1d75a816b6a554233074db78/src/rapidfuzz/process_py.py#L480
If they are I can push an extra commit in this PR to replace them with score_cutoff.

Thanks for maintaining this useful project!

Replace <= with > in "matches with a `distance <= score_cutoff` are
ignored" and replace >= with < in "matches with a `similarity >=
score_cutoff` are ignored".
Replace "abdD" with "abcD" in `extractOne("abcd", ["abdD"], ...)`in
order to match the reported results.
@maxbachmann
Copy link
Member

Thanks for the PR. Those are certainly mistakes in the documentation.

Also, are these 3 references to max outdated?

Yes this should just be score_cutoff.

@boolean5
Copy link
Contributor Author

Yes this should just be score_cutoff

Thanks for confirming. I just pushed a commit.

I changed The list is sorted by score_cutoff or max depending on the scorer used to The list is sorted by similarity or distance depending on the scorer used as I'm not sure what being sorted by score_cutoff means. Let me know if I guessed the intent right.

@maxbachmann
Copy link
Member

I changed The list is sorted by score_cutoff or max depending on the scorer used to The list is sorted by similarity or distance depending on the scorer used as I'm not sure what being sorted by score_cutoff means. Let me know if I guessed the intent right.

Yes that is a lot better explanation 👍

@maxbachmann maxbachmann merged commit 0340914 into rapidfuzz:main Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants