Skip to content

Corrected numerous typos in Markdown files. #1994

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ker2xu
Copy link

@ker2xu ker2xu commented Apr 5, 2025

Ragas is a great tool but the contents of the website can still be improved.

I corrected typos and unified some names (like langchain, Langchain -> LangChain) in Markdown documentation files. It seems that most of docs were written by a single author and lots of common typos were repeatly introduced. There are also some other problems about docs such as readability, categorization, clarification and more. I should have planned to polish them one by one but I may not have enough time to polish all of them, because I realized there are so many documentations after correcting typos for them. XD

This pull request only involves correcting typos and I recommend the contributor who is in charge of writing docs to have a look at the modifications to avoid introducing these typos in the future. You may also consider using LTex extension in VSCode extension market to recognize them (though it is not perfect).
The matching ipynb files are not corrected since I do not figure out a method to identify those typos in ipynb files easily. You may consider to correct the ipynb files as well so you can generate Markdown files accordingly.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Apr 5, 2025
@NirantK
Copy link
Contributor

NirantK commented Apr 5, 2025

Did you use an automatic linter for all markdown files? Because I see a lot of spurious changes around spaces etc. Maybe raise a smaller PR with just the spelling changes — that'd be faster to review and merge I expect.

@ker2xu
Copy link
Author

ker2xu commented Apr 5, 2025

Did you use an automatic linter for all markdown files? Because I see a lot of spurious changes around spaces etc. Maybe raise a smaller PR with just the spelling changes — that'd be faster to review and merge I expect.

I see... The space are trimmed by my VSCode automatically.

"files.trimTrailingWhitespace": true

@NirantK
Copy link
Contributor

NirantK commented Apr 5, 2025

Would you mind raising a PR with that flag set to false?

@ker2xu
Copy link
Author

ker2xu commented Apr 5, 2025

If there is a method that can recover those spaces back easily without bringing typos back, I would like to adopt it. But those trimmed lines have already been saved together with typo correction.

Personally, I tend to remove those trailing spaces as they are a little bit ugly. Furthermore, I would suggest including a pre-commit hook to prevent new commits from adding any trailing space.

@sahusiddharth
Copy link
Collaborator

Hi @ker2xu,

Thank you for your PR. I want to apologize and take responsibility for many of these errors that were introduced by me during documentation development.

Thank you for suggesting the LTex extension for VSCode - I'll definitely implement this in my workflow going forward.

Your pull request is much appreciated, and I'll be more mindful of these issues in future documentation. Thank you for helping make Ragas better for everyone in the community!

@sahusiddharth sahusiddharth self-requested a review April 5, 2025 15:49
@sahusiddharth
Copy link
Collaborator

It would be very helpful if you could let me know which files you've already reviewed and where you stopped your corrections.

I'll focus my attention on reviewing the remaining documentation files.

Copy link
Collaborator

@sahusiddharth sahusiddharth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggested two small changes

@ker2xu
Copy link
Author

ker2xu commented Apr 6, 2025

Hi @ker2xu,

Thank you for your PR. I want to apologize and take responsibility for many of these errors that were introduced by me during documentation development.

Thank you for suggesting the LTex extension for VSCode - I'll definitely implement this in my workflow going forward.

Your pull request is much appreciated, and I'll be more mindful of these issues in future documentation. Thank you for helping make Ragas better for everyone in the community!

You do not need to apologize for that. All people made and will make mistakes. 😀

I have completed a simple review of all Markdown files in the docs directory. While it's possible that a small number of files may have been inadvertently overlooked, the typos in them can be corrected when polishing their contents later.

@sahusiddharth sahusiddharth self-requested a review April 8, 2025 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:L This PR changes 100-499 lines, ignoring generated files.
3 participants