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: fix typo in function comment for clarity and grammar #1957

Closed
wants to merge 1 commit into from

Conversation

mdqst
Copy link

@mdqst mdqst commented Dec 4, 2024

Description:

There was a small grammatical error in the comment for the insertIndexPage function. The phrase:

"A function that insert a index page"

has been corrected to:

"A function that inserts an index page"

This change is important for both clarity and correctness. The verb "insert" should be in the third person singular form "inserts" to agree with the subject "function," and "a" should be replaced with "an" because "index" begins with a vowel sound. This small fix ensures the comment follows standard grammar rules and is easier to understand for developers reading the code.

Confirmation

Copy link

vercel bot commented Dec 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
maci-website ✅ Ready (Inspect) Visit Preview Dec 6, 2024 11:30am

Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

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

Thanks! Please ensure that your commit message respect the guidelines listed here https://maci.pse.dev/docs/contributing/#commits-rules - to amend your commit message you will need to follow these instructions: https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message

@mdqst mdqst changed the title Fix typo in function comment for clarity and grammar docs: fix typo in function comment for clarity and grammar Dec 4, 2024
@mdqst mdqst requested a review from ctrlc03 December 4, 2024 16:48
Copy link
Collaborator

@ctrlc03 ctrlc03 left a comment

Choose a reason for hiding this comment

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

you need to change the commit message not the title of the PR, please look at the links I provided.

@mdqst
Copy link
Author

mdqst commented Dec 4, 2024

you need to change the commit message not the title of the PR, please look at the links I provided.

I don't understand what the error is, I carefully read the documentation and made a pull request according to it.

@mdqst mdqst requested a review from ctrlc03 December 4, 2024 16:58
@ctrlc03
Copy link
Collaborator

ctrlc03 commented Dec 5, 2024

Fix typo in function comment for clarity and grammar

@mdqst your commit message is: "Fix typo in function comment for clarity and grammar" - however this cannot be accepted as is, it needs to be changed (for instance to docs: fix typo in function comment for clarity and grammar)
I've sent a link explaining how to change your commit messages and push the updated one https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Dec 20, 2024

While we appreciate you submitting this PR, we will be closing it to conform with our updated contributions guidelines https://maci.pse.dev/docs/contributing/ - cited: "We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation". We hope you see you contribute to the project, if in search for a task to take, please refer to our open issues, or contact the team.

@ctrlc03 ctrlc03 closed this Dec 20, 2024
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.

2 participants