search

rapidfuzz / RapidFuzz

Rapid fuzzy string matching in Python using various string metrics
https://rapidfuzz.github.io/RapidFuzz/
MIT License
2.61k stars 116 forks source link

broken docs #327

Closed nonchris closed 1 year ago

nonchris commented 1 year ago

Heyo, I wanted to fix it on my own and make a PR, but I can't find the place where the docs are actually written. The problem lies here, more concrete in the explanation of the scorer. There is written

"Further details can be found here"

But there is nothing clickable, what makes it kinda hard to find the other possibilities with explanation. I suppose it should reference to somewhere here, but I don't know.

Have a great day! Chris

maxbachmann commented 1 year ago

I think this should just be updated to the same text used for process.extract/process.extractOne/...

In theory there is a C API which would allow users to write their own scorers, but in praxis this is not documented right now.

maxbachmann commented 1 year ago

I updated the docs to use the same description for the scorer argument in all functions.