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.

Sign up for GitHub

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

Jump to bottom

Update docs for TokenFactory CLI --help #8248

Merged
merged 2 commits into from
May 13, 2024
Merged

Update docs for TokenFactory CLI --help #8248

merged 2 commits into from
May 13, 2024

Conversation

deividaspetraitis
Copy link
Contributor

Closes: #7942

What is the purpose of the change

As per issue #7942 decription:

when running osmosid tx tokenfactory the help documentation shows (Costs osmo though!), while since may 2023 this is not the case anymore (#4983).

This MR simply updates docs by removing (Costs osmo though!) from the TokenFactory CLI help docs.

Testing and Verifying

This change is a trivial rework / code cleanup without any test coverage.

Documentation and Release Note

  • Does this pull request introduce a new feature or user-facing behavior changes?
  • Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

  • Specification (x/{module}/README.md)
  • Osmosis documentation site
  • Code comments?
  • N/A

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 9, 2024 •
edited
Loading

Walkthrough

The update in the osmosisd tx tokenfactory CLI command simplifies the description for creating a new denomination by removing the outdated reference to a cost in osmo. This change aims to prevent user confusion and potential financial errors related to transaction fees.

Changes

File Path Change Summary
x/tokenfactory/client/cli/tx.go Updated command description for create-denom

Assessment against linked issues

Objective Addressed Explanation
Update help documentation for create-denom to remove outdated fee mention (#7942) ✅

🐇
In the garden of code, where the CLI blooms,
A rabbit tweaked the text, dispelling old glooms.
No more osmo fees, in the command's tune,
Just clear instructions, under the tech moon.
🌙🌟

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 6e3e03b and 939d12e.
Files selected for processing (1)
  • x/tokenfactory/client/cli/tx.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/tokenfactory/client/cli/tx.go

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 your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@deividaspetraitis deividaspetraitis mentioned this pull request May 9, 2024
Closed
PaddyMc
PaddyMc reviewed May 9, 2024
View reviewed changes
x/tokenfactory/client/cli/tx.go
@@ -29,7 +29,7 @@ func GetTxCmd() *cobra.Command {
func NewCreateDenomCmd() *cobra.Command {
return osmocli.BuildTxCli[*types.MsgCreateDenom](&osmocli.TxCliDesc{
Use: "create-denom",
Short: "create a new denom from an account. (Costs osmo though!)",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should update this to say:

(osmo to create tokens is charged through gas consumption)

It still costs osmo to create tokens, but the mechanism has changed. wdyt?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for feedback! I have updated docs as per your suggestion.

@PaddyMc PaddyMc added A:backport/v25.x backport patches to v25.x branch V:state/compatible/backport State machine compatible PR, should be backported A:no-changelog labels May 10, 2024
@PaddyMc PaddyMc closed this May 13, 2024
@PaddyMc PaddyMc reopened this May 13, 2024
@PaddyMc PaddyMc merged commit 98d9b60 into osmosis-labs:main May 13, 2024
1 check passed
@PaddyMc
Copy link
Collaborator

PaddyMc commented May 13, 2024

Thanks for the contribution

mergify bot pushed a commit that referenced this pull request May 13, 2024
@deividaspetraitis @mergify
Update docs for TokenFactory CLI --help (#8248)
1e737f6 
* Update docs

* requested changes

(cherry picked from commit 98d9b60)
@mergify mergify bot mentioned this pull request May 13, 2024
Merged
6 tasks
PaddyMc pushed a commit that referenced this pull request May 13, 2024
@mergify @deividaspetraitis
Update docs for TokenFactory CLI --help (#8248) (#8258)
6168b9e 
* Update docs

* requested changes

(cherry picked from commit 98d9b60)

Co-authored-by: Deividas Petraitis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattverse mattverse mattverse approved these changes

@PaddyMc PaddyMc PaddyMc approved these changes

@nicolaslara nicolaslara Awaiting requested review from nicolaslara nicolaslara is a code owner

@p0mvn p0mvn Awaiting requested review from p0mvn p0mvn is a code owner

Assignees
No one assigned
Labels
A:backport/v25.x backport patches to v25.x branch A:no-changelog C:CLI C:x/tokenfactory V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: TokenFactory CLI --help for create-denom is outdated as it includes (cost osmo though!)
3 participants
@deividaspetraitis @PaddyMc @mattverse