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 #326

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

Conversation

evg1nn-eth
Copy link

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:

  • "Once publish core-sdk" — the phrase needs correction for grammatical correctness. It should be "Once you publish the core-sdk".

  • "published in store" — the phrase needs clarification. It would be better to write "published to the store".

  • "The preceding code created the account object" — the verb tense should be present, not past, since it's describing an action. It should be "The preceding code creates the account object".

  • "created the account object for creating" — there is repetition of the word "creating." It should be rewritten as "creates the account object for the SDK client".

  • "store." — the word "store" in this context may be unclear. It would be better to change it to "the store".

  • "need you are trying to solve" — the phrase should be "need that you are trying to solve."

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)
  • I have made corresponding changes to the documentation

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

DonFungible and others added 6 commits November 11, 2024 00:53
* make isRegistered public

* make isRegistered public
* Add batchMintAndRegisterIpAssetWithPilTerms method

* Add batchRegisterDerivative method

* Enhance batchMintAndRegisterIpAssetWithPilTerms including unit tests and annotation

* Add batchMintAndRegisterIpAndMakeDerivative method

* Add batch register method

* Fix issue about Invalid signature

* Refactor code

* Add unit tests

* Fix unit test

* Export getSignature method

* Add batchRegisterWithIpMetadata method

* Enhance code

* Refactor multicall about protocol core

* Remove integration test in command

* Refactor getDeadline method

* Bump up sdk to 1.2.0-rc.2
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