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

chore: typos fix by misspell-fixer #18683

Merged
merged 3 commits into from
Dec 11, 2023
Merged

chore: typos fix by misspell-fixer #18683

merged 3 commits into from
Dec 11, 2023

Conversation

github-prbot
Copy link
Contributor

@github-prbot github-prbot commented Dec 11, 2023

This PR fixes typos in the codebase.
Please, review it and merge if everything is fine.
If there is proto changes, please, run make proto-gen and commit changes.

Summary by CodeRabbit

  • Documentation

    • Improved clarity and fixed typos in various documentation files and comments.
    • Updated descriptions to reflect deprecation of certain fields in governance parameters.
    • Emphasized consistency in metadata storage descriptions for client applications.
  • Bug Fixes

    • Corrected spelling errors in variable names and comments across multiple modules.
  • Refactor

    • Deprecated fields in governance parameters to streamline the configuration process.
  • Style

    • Standardized spelling for terms like "initializing" and "occurred" in comments and documentation.

@github-prbot github-prbot requested a review from a team as a code owner December 11, 2023 08:02
Copy link
Contributor

coderabbitai bot commented Dec 11, 2023

Walkthrough

Walkthrough

The changes across various files are primarily focused on correcting typographical errors and improving the clarity of comments and documentation. Key updates include deprecating fields in the Cosmos SDK's governance module and refining comments for consistency and accuracy. No changes to the logic or functionality of the code are indicated, suggesting a maintenance and documentation improvement effort.

Changes

File(s) Summary
CHANGELOG.md, docs/architecture/adr-037-gov-split-vote.md, docs/architecture/adr-050-sign-mode-textual.md, docs/spec/fee_distribution/f1_fee_distr.tex, x/auth/vesting/README.md, x/authz/README.md, x/gov/README.md, x/staking/README.md Corrected typographical errors in documentation and comments.
api/cosmos/gov/v1/genesis.pulsar.go, api/cosmos/gov/v1/query.pulsar.go, proto/cosmos/gov/v1/genesis.proto, proto/cosmos/gov/v1/query.proto Updated comments and deprecated fields related to deposit, voting, and tally parameters.
api/cosmos/staking/v1beta1/staking.pulsar.go, proto/cosmos/staking/v1beta1/staking.proto Fixed a typo from "occured" to "occurred" in comments.
docs/build/building-modules/01-module-manager.md Corrected "Contructor" to "Constructor" in function description.
tests/e2e/auth/suite.go Renamed variable from "intialCoins" to "initialCoins".
x/gov/types/config.go, x/group/internal/orm/sequence_property_test.go Corrected "intialising" to "initialising" in comments.
x/nft/simulation/operations.go Changed variable name from recieverStr to receiverStr.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8cfdabb and 530163a.
Files ignored due to filter (3)
  • x/gov/types/v1/genesis.pb.go
  • x/gov/types/v1/query.pb.go
  • x/staking/types/staking.pb.go
Files selected for processing (19)
  • CHANGELOG.md (3 hunks)
  • api/cosmos/gov/v1/genesis.pulsar.go (1 hunks)
  • api/cosmos/gov/v1/query.pulsar.go (1 hunks)
  • api/cosmos/staking/v1beta1/staking.pulsar.go (1 hunks)
  • docs/architecture/adr-037-gov-split-vote.md (1 hunks)
  • docs/architecture/adr-050-sign-mode-textual.md (1 hunks)
  • docs/build/building-modules/01-module-manager.md (1 hunks)
  • docs/spec/fee_distribution/f1_fee_distr.tex (1 hunks)
  • proto/cosmos/gov/v1/genesis.proto (1 hunks)
  • proto/cosmos/gov/v1/query.proto (1 hunks)
  • proto/cosmos/staking/v1beta1/staking.proto (1 hunks)
  • tests/e2e/auth/suite.go (2 hunks)
  • x/auth/vesting/README.md (1 hunks)
  • x/authz/README.md (1 hunks)
  • x/gov/README.md (1 hunks)
  • x/gov/types/config.go (1 hunks)
  • x/group/internal/orm/sequence_property_test.go (1 hunks)
  • x/nft/simulation/operations.go (2 hunks)
  • x/staking/README.md (1 hunks)
Files skipped from review due to trivial changes (15)
  • CHANGELOG.md
  • api/cosmos/gov/v1/query.pulsar.go
  • api/cosmos/staking/v1beta1/staking.pulsar.go
  • docs/architecture/adr-037-gov-split-vote.md
  • docs/architecture/adr-050-sign-mode-textual.md
  • docs/spec/fee_distribution/f1_fee_distr.tex
  • proto/cosmos/gov/v1/genesis.proto
  • proto/cosmos/gov/v1/query.proto
  • proto/cosmos/staking/v1beta1/staking.proto
  • tests/e2e/auth/suite.go
  • x/auth/vesting/README.md
  • x/authz/README.md
  • x/gov/types/config.go
  • x/group/internal/orm/sequence_property_test.go
  • x/staking/README.md
Additional comments: 6
api/cosmos/gov/v1/genesis.pulsar.go (1)
  • 1243-1260: The comments have been updated to correct typographical errors and to mark certain fields as deprecated, guiding users to prefer the params field. This aligns with the PR's objective of fixing typos and updating documentation without altering the functionality of the code.
docs/build/building-modules/01-module-manager.md (1)
  • 275-276: The typo in the function description of NewBasicManagerFromManager has been corrected from "Contructor" to "Constructor." This is a textual change and does not affect the functionality of the code.
x/gov/README.md (1)
  • 2487-2493: The addition to the documentation provides clear guidelines on where and how metadata should be stored for proposals and votes within the governance module. It emphasizes consistency between the gov and group modules and the importance of client applications being able to rely on the structure of metadata across chains. The JSON structure provided for both proposal and vote metadata is concise and aligns with the recommendations for off-chain and on-chain storage respectively.
x/nft/simulation/operations.go (3)
  • 95-98: The variable name change from recieverStr to receiverStr is consistent with the PR's objective to fix typographical errors and does not alter the logic or functionality of the code. This change improves code readability and correctness.

  • 101-104: The corrected variable name receiverStr is properly used in the Receiver field of the MsgSend struct, aligning with the PR's objective to fix typographical errors.

  • 92-98: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [1-107]

Verify if there are any changes to proto files in this PR and ensure that the make proto-gen command has been run to generate the necessary changes, which should be included in the commit.


The verification process confirms that proto files have been modified in this PR, and corresponding .pb.go files have also been updated. This suggests that the make proto-gen command was likely run to generate the necessary changes, which are included in the commit.

Final review comment:

Verified that proto files have been updated and the necessary generated files are included in the commit.

@julienrbrt julienrbrt enabled auto-merge December 11, 2023 08:13
@DongLieu
Copy link
Contributor

It doesn't seem to work as well as codespell.

I tried the bot/fix-typo branch and there were still a lot of typos.

cc: @julienrbrt

@julienrbrt julienrbrt added this pull request to the merge queue Dec 11, 2023
Merged via the queue into main with commit e84b191 Dec 11, 2023
64 of 67 checks passed
@julienrbrt julienrbrt deleted the bot/fix-typos branch December 11, 2023 09:12
@julienrbrt
Copy link
Member

julienrbrt commented Dec 11, 2023

It doesn't seem to work as well as codespell.

I tried the bot/fix-typo branch and there were still a lot of typos.

cc: @julienrbrt

Very true, we could update the job to use codespell instead.
However, is the first run of the bot, so maybe it will find other issues at its second run tomorrow 🤷🏾‍♂️— still better to have everything resolved faster.

@DongLieu
Copy link
Contributor

I understand contributors do not accept typo issues.

But what do you think of a PR that solves almost all typos?

@julienrbrt
Copy link
Member

I understand contributors do not accept typo issues.

But what do you think of a PR that solves almost all typos?

We'll let the bot do it: #18686, but thanks for the suggestion :)

marcello33 added a commit to 0xPolygon/cosmos-sdk that referenced this pull request Dec 13, 2023
* feat: secp256k1 public key constant time (cosmos#18026)

Signed-off-by: bizk <[email protected]>

* chore: Fixed changelog duplicated items (cosmos#18628)

* adr: Un-Ordered Transaction Inclusion (cosmos#18553)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>

* docs: lint ADR-070 (cosmos#18634)

* fix(baseapp)!: postHandler should run regardless of result (cosmos#18627)

* docs: fix typos in adr-007-specialization-groups.md (cosmos#18635)

* chore: alphabetize labels (cosmos#18640)

* docs(x/circuit): add note on ante handler (cosmos#18637)

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

* fix: telemetry metric label variable (cosmos#18643)

* chore: typos fix (cosmos#18642)

* refactor(store/v2): updates from integration (cosmos#18633)

* build(deps): Bump actions/setup-go from 4 to 5 (cosmos#18647)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* feat(store/v2): snapshot manager (cosmos#18458)

* chore(client/v2): fix typos in the README.md (cosmos#18657)

* fix(baseapp):  protocompat.go gogoproto.Merge does not work with custom types (cosmos#18654)

Co-authored-by: unknown unknown <unknown@unknown>

* chore: fix several minor typos (cosmos#18660)

* chore(tools/confix/cmd): fix typo in view.go (cosmos#18659)

* refactor(x/staking): check duplicate addresses in StakeAuthorization's params (cosmos#18655)

* feat(accounts): use gogoproto API instead of protov2.  (cosmos#18653)

Co-authored-by: unknown unknown <unknown@unknown>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix(store/commitment/iavl): honor tree.Remove error firstly (cosmos#18651)

* build(deps): Bump actions/stale from 8 to 9 (cosmos#18656)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(docs): fix typos & wording in docs (cosmos#18667)

* chore: fix several typos.   (cosmos#18666)

* feat(telemetry): enable `statsd` and `dogstatsd` telemetry sinks (cosmos#18646)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
Co-authored-by: marbar3778 <[email protected]>
Co-authored-by: Marko <[email protected]>

* feat(store/v2): add SetInitialVersion in SC (cosmos#18665)

* feat(client/keys): support display discreetly for `keys add` (cosmos#18663)

Co-authored-by: Julien Robert <[email protected]>

* ci: add misspell action (cosmos#18671)

* chore: typos fix by misspell-fixer (cosmos#18683)

Co-authored-by: github-merge-queue <[email protected]>
Co-authored-by: Julien Robert <[email protected]>

* chore: add v0.50.2 changelog to main (cosmos#18682)

* build(deps): Bump github.com/jhump/protoreflect from 1.15.3 to 1.15.4 in /tests (cosmos#18678)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* refactor(bank): remove .String() calls  (cosmos#18175)

Co-authored-by: Facundo <[email protected]>

* ci: use codespell instead of misspell-fixer (cosmos#18686)

Co-authored-by: Marko <[email protected]>

* feat(gov): add proposal types and spam votes (cosmos#18532)

* feat(accounts): use account number as state prefix for account state (cosmos#18664)

Co-authored-by: unknown unknown <unknown@unknown>

* chore: typos fixes by cosmos-sdk bot (cosmos#18689)

Co-authored-by: github-merge-queue <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
Co-authored-by: marbar3778 <[email protected]>

* feat(client/keys): support display discreetly for keys mnemonic (cosmos#18688)

* refactor: remove panic usage in keeper methods (cosmos#18636)

* ci: rename pr name in misspell job (cosmos#18693)

Co-authored-by: Marko <[email protected]>

* build(deps): Bump github.com/pelletier/go-toml/v2 from 2.1.0 to 2.1.1 in /tools/confix (cosmos#18702)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* feat(client/keys): support display discreetly for keys export (cosmos#18684)

* feat(x/gov): better gov genesis validation (cosmos#18707)

---------

Signed-off-by: bizk <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Carlos Santiago Yanzon <[email protected]>
Co-authored-by: yihuang <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
Co-authored-by: Facundo Medica <[email protected]>
Co-authored-by: Akaonetwo <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
Co-authored-by: dreamweaverxyz <[email protected]>
Co-authored-by: Pioua <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: cool-developer <[email protected]>
Co-authored-by: leonarddt05 <[email protected]>
Co-authored-by: testinginprod <[email protected]>
Co-authored-by: unknown unknown <unknown@unknown>
Co-authored-by: Sukey <[email protected]>
Co-authored-by: axie <[email protected]>
Co-authored-by: Luke Ma <[email protected]>
Co-authored-by: Emmanuel T Odeke <[email protected]>
Co-authored-by: 0xn4de <[email protected]>
Co-authored-by: hattizai <[email protected]>
Co-authored-by: Devon Bear <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: Halimao <[email protected]>
Co-authored-by: Cosmos SDK <[email protected]>
Co-authored-by: github-merge-queue <[email protected]>
Co-authored-by: Facundo <[email protected]>
Co-authored-by: Likhita Polavarapu <[email protected]>
@marcello33 marcello33 mentioned this pull request Jan 22, 2024
12 tasks
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