Skip to content

Fix grammar and tense in API coexistence explanation #324

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

Merged
merged 1 commit into from
Jul 2, 2025

Conversation

I-Ying-Tsai
Copy link
Contributor

@I-Ying-Tsai I-Ying-Tsai commented Jul 2, 2025

The original sentence was ungrammatical and slightly unclear.
This patch improves the article usage, verb tense, and phrasing
to ensure clarity and correctness.

Summary by Bito

This pull request enhances the clarity and grammatical correctness of the API coexistence documentation in the Linux kernel. It improves phrasing and verb tense for better understanding, making the documentation more precise and easier to read.

@visitorckw
Copy link
Contributor

Original: "One of the reasons why API was changed is it need to coexist with the old version interface."

Issues:

  • Missing article ("the API")
  • Verb tense disagreement ("it need" → "it needed")
  • Unnatural phrase ("old version interface")

Revised: "One of the reasons why the API was changed is that it needed to coexist with the old version of the interface."

You don't need to include the full "Original" and "Revised" texts in the changelog. The git diff already shows the specific changes. Instead, please focus the changelog on why the change is necessary, rather than detailing exactly what was changed.

@I-Ying-Tsai
Copy link
Contributor Author

Thank you! I've updated the commit accordingly

Copy link
Contributor

@jserv jserv left a comment

Choose a reason for hiding this comment

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

Read https://cbea.ms/git-commit/ carefully and enforce the rules.

@I-Ying-Tsai
Copy link
Contributor Author

Sorry for forgetting this. I've updated the commit message and PR description accordingly. Thank you!

Copy link
Contributor

@visitorckw visitorckw left a comment

Choose a reason for hiding this comment

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

I saw that you updated the PR description, but the commit message in the git history hasn't been updated yet.

The original sentence was ungrammatical and slightly unclear.
This patch improves the article usage, verb tense, and phrasing
to ensure clarity and correctness.
@I-Ying-Tsai I-Ying-Tsai force-pushed the fix-api-coexistence-grammar branch from 5892a42 to e68c016 Compare July 2, 2025 13:19
@I-Ying-Tsai
Copy link
Contributor Author

Commit message has been updated to follow project and community guidelines. Thanks for the reminder!

@jserv jserv merged commit 9e54fe1 into sysprog21:master Jul 2, 2025
1 check passed
@jserv
Copy link
Contributor

jserv commented Jul 2, 2025

Thank @I-Ying-Tsai for contributing!

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.

3 participants