Skip to content
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

Docs improvements #842

Closed
wants to merge 3 commits into from
Closed

Conversation

nnsW3
Copy link

@nnsW3 nnsW3 commented Jun 25, 2024

Rectify typographical inaccuracies

This PR addresses several typographical errors across various files in the project. The changes improve readability and maintain the professional standard of the documentation and code comments.

Justification
Typographical errors, while minor, can detract from the overall quality of the project. Correcting these errors ensures clarity and professionalism, making the project more accessible and understandable for current and future contributors.

@nnsW3 nnsW3 requested review from a team as code owners June 25, 2024 15:58
@nnsW3 nnsW3 requested review from z-tech, mmagician and weikengchen and removed request for a team June 25, 2024 15:58
@mmaker
Copy link
Member

mmaker commented Jun 25, 2024

thanks!

@mmagician
Copy link
Member

looks like commit farming if you ask me

@mmaker
Copy link
Member

mmaker commented Jun 25, 2024

I know, but also i don't know if it's a good ground to reject the PR of a new user. Maybe we should squash these sort of PR ?

@nnsW3
Copy link
Author

nnsW3 commented Jun 25, 2024

I am trying to contribute with typos, even if I am not yet able to make improvements to the code, I know it is not much but maybe it helps.

@mmagician
Copy link
Member

@mmaker it's hard to say in general, I just wanna point out that these are not meaningful typos.

@nnsW3
Copy link
Author

nnsW3 commented Jun 25, 2024

i have done my best is up to you, is hard to read all that docs, to be honest but your call sir

@weikengchen
Copy link
Member

We do not encourage minor PRs for typos. I would close this PR.

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.

4 participants