Corrected numerous typos in Markdown files. - #1994
Conversation
dosubot
Bot
added
the
size:L
|
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 |
|
Would you mind raising a PR with that flag set to |
|
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. |
|
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! |
|
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. |
sahusiddharth
left a comment
sahusiddharth
left a comment
There was a problem hiding this comment.
suggested two small changes
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 |
|
@ker2xu Please rebase and fix the merge conflicts. Also, if possible, only update the typos in this PR. If you want to work on formatting fixes, please open a separate PR for it. It'll be easier to review. Alternatively, we can close this and you can open a new PR with the clean fixes. |
|
@anistark Conflicts resolved. Thanks for your suggestion and it is definitely better to correct typos and formatting issues in separate PRs. However, I am not available recently and separating these two modifications may take much more time than simply reviewing them. It would be great if you could review them together this time. Thank you. |
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. --------- Co-authored-by: Siddharth Sahu <112792547+sahusiddharth@users.noreply.github.com>
4 participants
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.