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 typos in comments and documentation across multiple files #20676

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

Conversation

Dimitrolito
Copy link

This pull request addresses typographical errors in comments and documentation in several files across the codebase. These changes improve the readability and professionalism of the project without affecting functionality.

Key Changes:

  1. Comments:

    • Corrected "a address" to "an address" in multiple locations.
    • Fixed incorrect usages such as "a HTTP" -> "an HTTP" and "a owned object" -> "an owned object."
    • Fixed redundant words like "preventing preventing" in comments.
  2. Documentation:

    • Updated "an vector" to "a vector" in the Move documentation.
    • Clarified phrasing to improve overall comprehension.

Test Plan:
No functionality was changed, so testing was limited to confirming no compilation or linting issues in affected files.


Release Notes:

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API: Documentation updates for SSH commands and error handling.

Impact:
No user-facing changes beyond improved documentation clarity.

@Dimitrolito Dimitrolito requested review from a team and ronny-mysten as code owners December 18, 2024 19:00
Copy link

vercel bot commented Dec 18, 2024

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

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 6:47pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Dec 23, 2024 6:47pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Dec 23, 2024 6:47pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Dec 23, 2024 6:47pm

Copy link
Contributor

@stefan-mysten stefan-mysten left a comment

Choose a reason for hiding this comment

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

Thanks @Dimitrolito!

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