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 documentation files #15248

Merged
merged 6 commits into from
Nov 16, 2024
Merged

Conversation

leopardracer
Copy link
Contributor

Description
This pull request addresses several spelling and grammatical issues across the codebase. These changes help improve code clarity and reduce the likelihood of confusion for contributors and users. Specifically, the following corrections were made:

"stablized" → "stabilized"
"xclippy" → "clippy"
"offerred" → "offered"
"respone" → "response"
"valdiator" → "validator"
These fixes were primarily applied in variable names, comments, and documentation.
No new dependencies were introduced as part of these changes.

How Has This Been Tested?
The changes do not affect functionality but improve code readability. As a result, no new tests were needed.
All existing unit and integration tests were run to ensure the correctness of the system.

Key Areas to Review

  • New feature
  • Bug fix
  • Breaking change
  • Performance improvement
  • Refactoring
  • Dependency update
  • Documentation update
  • Tests

Which Components or Systems Does This Change Impact?

  • Validator Node
  • Documentation
  • Codebase (comments, variable names)
  • Full Node (API, Indexer, etc.)
  • Move/Aptos Virtual Machine
  • Aptos Framework
  • Aptos CLI/SDK
  • Developer Infrastructure
  • Move Compiler
  • Other (specify)

Checklist

  • I have read and followed the CONTRIBUTING doc
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I identified and added all stakeholders and component owners affected by this change as reviewers
  • I tested both happy and unhappy path of the functionality
  • I have made corresponding changes to the documentation

Copy link

trunk-io bot commented Nov 9, 2024

⏱️ 30m total CI duration on this PR
Job Cumulative Duration Recent Runs
rust-move-tests 12m 🟩
rust-move-tests 9m 🟩
rust-cargo-deny 4m 🟩🟩
check-dynamic-deps 3m 🟩🟩
general-lints 54s 🟩🟩
semgrep/ci 50s 🟩🟩
file_change_determinator 24s 🟩🟩
permission-check 5s 🟥🟩
permission-check 4s 🟥🟩
check-terraform-modifications 1s 🟥🟥

settingsfeedbackdocs ⋅ learn more about trunk.io

@leopardracer
Copy link
Contributor Author

@davidiw Hi! Apologies for the inconvenience. I just wanted to check if there’s anything I can improve in my pull request. Please feel free to ask any questions or let me know if any changes are needed to meet the project's merge requirements. I’m happy to make adjustments!

@davidiw
Copy link
Contributor

davidiw commented Nov 16, 2024

Nope! Just was at Devcon last week, so missed this. Let's make it happen :)

@leopardracer
Copy link
Contributor Author

@davidiw Could you please tell me if I need to make any more changes before merging?

@davidiw davidiw merged commit 4f3ee4f into aptos-labs:main Nov 16, 2024
27 checks passed
@georgemitenkov
Copy link
Contributor

This breaks the generation of docs for Move files, from_bcs.md should not be modified, but from_bcs.move should.

@davidiw
Copy link
Contributor

davidiw commented Nov 16, 2024

This breaks the generation of docs for Move files, from_bcs.md should not be modified, but from_bcs.move should.

Crud, the linters didn't pick that up... Can you help push a new pr?

@@ -12,7 +12,7 @@ The `--check` flag can be used to check if the code is formatted correctly.
./scripts/rust_lint.sh
```

> **Note:** xclippy is an alias for `cargo clippy` with additional flags to enable more lints.
> **Note:** clippy is an alias for `cargo clippy` with additional flags to enable more lints.
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

8dc501b
Good call, fixed

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.

4 participants