-
Notifications
You must be signed in to change notification settings - Fork 153
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this 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
There was a problem hiding this 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.
I don't understand what the error is, I carefully read the documentation and made a pull request according to it. |
@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) |
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. |
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