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

Fix documentation typos and grammar #2410

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Madmaxs2
Copy link

@Madmaxs2 Madmaxs2 commented Nov 26, 2024

Changes:

  1. In packages/hub-nodejs/docs/Client.md:
  • Changed "quick" to "quirk"
  • Reason: The word "quick" (meaning fast/rapid) was incorrectly used where "quirk" (meaning peculiarity/oddity) was intended when describing protobuf-generated types behavior.
  1. In packages/hub-nodejs/docs/Client.md:
  • Changed "Message are" to "Messages are"
  • Reason: Fixed subject-verb agreement as "Messages" is plural and requires the plural verb form "are".
  1. In protobufs/README.md:
  • Changed "Docs for the protobufs is" to "Docs for the protobufs are"
  • Reason: Fixed subject-verb agreement as "Docs" (documentation) is treated as plural in this context and requires the plural verb form "are".
    These changes improve the documentation's readability and grammatical correctness without altering any technical content.

PR-Codex overview

This PR primarily focuses on improving documentation clarity in the protobufs/README.md and packages/hub-nodejs/docs/Client.md files, correcting minor typographical errors and ensuring consistency in language.

Detailed summary

  • Fixed a minor typographical error in protobufs/README.md regarding the documentation description.
  • Corrected "quick" to "quirk" in packages/hub-nodejs/docs/Client.md.
  • Changed "Docs for the protobufs is" to "Docs for the protobufs are" for grammatical accuracy in protobufs/README.md.
  • Changed "Message are" to "Messages are" in packages/hub-nodejs/docs/Client.md for grammatical accuracy.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Nov 26, 2024

⚠️ No Changeset found

Latest commit: efa5686

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 26, 2024

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

Name Status Preview Comments Updated (UTC)
hub-monorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 5:07pm

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.

1 participant