Skip to content

Add spell checker#169

Closed
whybe-choi wants to merge 1 commit into
lightonai:mainfrom
whybe-choi:fix-typos
Closed

Add spell checker#169
whybe-choi wants to merge 1 commit into
lightonai:mainfrom
whybe-choi:fix-typos

Conversation

@whybe-choi
Copy link
Copy Markdown
Contributor

@whybe-choi whybe-choi commented Oct 27, 2025

This pull request primarily focuses on correcting spelling and grammar errors throughout the documentation and code comments to improve clarity and professionalism. The changes address typos, word choice, and consistency in terminology across multiple files related to evaluation, indexing, and loss functions.

Documentation and comment corrections:

  • Fixed spelling errors such as "matchs" to "matches", "commiting" to "committing", "assymetric" to "asymmetric", "compilatible" to "compatible", and "recommand" to "recommend" in various docstrings and markdown files. [1] [2] [3] [4] [5] [6] [7] [8]
  • Updated terminology for reproducibility and similarity, such as changing "reproducable" to "reproducible" and "similarites" to "similarities" in documentation and code comments. [1] [2] [3] [4] [5]
  • Corrected variable and parameter names in code and docstrings to maintain consistency, including changing "query_matchs" to "query_matches", "matchs" to "matches", and "assocaited" to "associated". [1] [2] [3] [4] [5]
  • Fixed typos in comments and internal variables, such as "apppear" to "appear", "EVENTAULLY" to "EVENTUALLY", and "INITALIZED" to "INITIALIZED". [1] [2] [3] [4]

@Samoed
Copy link
Copy Markdown
Contributor

Samoed commented Oct 27, 2025

You can try to run https://github.com/crate-ci/typos/ like in embeddings-benchmark/mteb#3476

@whybe-choi
Copy link
Copy Markdown
Contributor Author

Thank you for letting me know. It's really a cool tool!

@whybe-choi whybe-choi changed the title Fix typos in ColBERT Add spell checker Oct 27, 2025
@Samoed
Copy link
Copy Markdown
Contributor

Samoed commented Oct 27, 2025

I'm not maintainer, so I just suggest to you. You can just for check typos without adding typos in repo

@whybe-choi
Copy link
Copy Markdown
Contributor Author

I’m aware of it. That’s why I’m currently double-checking if there are any issues caused by changes in variable or function names after running the spelling check with typos. Nevertheless, thank you for your kind guidance!

@NohTow
Copy link
Copy Markdown
Collaborator

NohTow commented Oct 28, 2025

IIUC, you ran the spell checker, it isn't added to the checks right?

@whybe-choi
Copy link
Copy Markdown
Contributor Author

whybe-choi commented Oct 28, 2025

Yes, that's correct. I set the PR title incorrectly. Functions like compute_metrices are modified by the spell checker, and in such cases, it seems to cause problems in the code, so I couldn't add it carelessly.

@NohTow NohTow mentioned this pull request Oct 28, 2025
@NohTow
Copy link
Copy Markdown
Collaborator

NohTow commented Oct 28, 2025

Closed because #173 was merged, sorry for the duplicate again

@NohTow NohTow closed this Oct 28, 2025
@Samoed
Copy link
Copy Markdown
Contributor

Samoed commented Oct 28, 2025

Yes, that's correct. I set the PR title incorrectly. Functions like compute_metrices are modified by the spell checker, and in such cases, it seems to cause problems in the code, so I couldn't add it carelessly.

You can configure spell checker to ignore some words

@whybe-choi whybe-choi deleted the fix-typos branch October 28, 2025 14:37
@Samoed Samoed mentioned this pull request Oct 28, 2025
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.

3 participants