Better tokenizer
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 88
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
fromOldClient does not return any result in docs.cozy.io search.
CozyClient.fromOldClient does return the result.
IMHO this is caused by the tokenizer, that considers the point not to be separating two words which causes "fromOldClient" not to be a word.
I think we tweaked the tokenizer because we needed doctypes to be returned as is, that is : the dot should not split doctypes like "io.cozy.bills" but should split CozyClient.fromOldClient.
Since doctypes can be inferred as having at least 2 dots, and no starting capital, we could maybe improve the tokenizer to support both cases.
See https://github.com/cozy/cozy.github.io/blob/ffda0e0e370c19b3cabee02081f0c995856d363a/mkdocs.yml#L221
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the search configuration referenced in mkdocs.yml at line 221 and reproduce the issue by searching for "fromOldClient" and "CozyClient.fromOldClient" on docs.cozy.io. Done means both forms return the expected documentation while doctypes such as "io.cozy.bills" remain intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, search
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100