docs(x/authz): update grant docs

[ziscky]

Description

Closes: #11122

This PR improves the authz client doc examples.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Documentation
  • Clarified that the MaxTokens parameter in StakeAuthorization is optional, allowing for unlimited configuration.
  • Expanded the grant command documentation with detailed explanations of various authorization_type options and their flags, enhancing user understanding of authorization features.

[coderabbitai]

Walkthrough

Walkthrough

The changes in the pull request focus on enhancing the documentation of the x/authz module, specifically regarding the StakeAuthorization and the grant command. The README.md file has been updated to clarify that the MaxTokens parameter in StakeAuthorization is optional. Additionally, the documentation for the grant command has been expanded to detail the various authorization_type options and their associated flags, improving the overall clarity and usability of the documentation.

Changes

File	Change Summary
x/authz/README.md	Updated description of StakeAuthorization to indicate MaxTokens is optional; expanded documentation for the grant command with detailed descriptions of authorization_type options and their flags.

Assessment against linked issues

Objective	Addressed	Explanation
authz docs are incomplete (#[11122])	✅

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[julienrbrt]

nit: no changelog required for docs.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (5)

x/authz/README.md (5)

87-87: Documentation update looks good, but consider rephrasing.

The change correctly updates the documentation to reflect that MaxTokens is optional in StakeAuthorization.

However, consider rephrasing "amount of tokens" to "number of tokens" as "amount" is typically used with uncountable nouns.

Tools

LanguageTool

[uncategorized] ~87-~87: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ens` that keeps track of a limit to the amount of tokens that can be delegated/undeleg...

(AMOUNTOF_TO_NUMBEROF)

---

279-285: Documentation for send authorization type looks good, but fix the formatting.

The added documentation clearly explains the custom flags available for the send authorization type.

However, please address the following formatting issues for consistency:

• Use asterisks instead of dashes for the unordered list.
• Add blank lines before and after the fenced code block.

Tools

Markdownlint

279-279: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

285-285: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

279-279: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

279-279: Expected: #sendauthorization; Actual: #SendAuthorization
Link fragments should be valid

(MD051, link-fragments)

---

286-293: Documentation for generic authorization type looks good, but fix the formatting and grammar.

The added documentation clearly explains the generic authorization type and its required msg-type flag.

However, please address the following issues:

• Use asterisks instead of dashes for the unordered list.
• Add blank lines before and after the fenced code block.
• Change "any valid Cosmos SDK Msg type url" to "a valid Cosmos SDK Msg type url" for better grammar.

Tools

LanguageTool

[uncategorized] ~288-~288: “any” seems less likely than “a”.
Context: ...cAuthorization). > Note: msg-type is any valid Cosmos SDK Msg type url. Examp...

(AI_HYDRA_LEO_CP_ANY_AN)

Markdownlint

286-286: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

291-291: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

293-293: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

286-286: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

286-286: Expected: #genericauthorization; Actual: #GenericAuthorization
Link fragments should be valid

(MD051, link-fragments)

---

294-296: Documentation for delegate, unbond, and redelegate authorization types looks good, but fix the formatting and link.

The added documentation clearly explains the delegate, unbond, and redelegate authorization types and their optional flags.

However, please address the following issues:

• Use asterisks instead of dashes for the unordered list.
• Add blank lines before and after the list.
• Change the link fragment from #StakeAuthorization to #stakeauthorization for consistency with the other link fragments.

Tools

Markdownlint

294-294: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

294-294: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

294-294: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

294-294: Expected: #stakeauthorization; Actual: #StakeAuthorization
Link fragments should be valid

(MD051, link-fragments)

---

288-289: Note about msg-type looks good, but consider a minor grammar improvement.

The note provides a helpful clarification that msg-type can be any valid Cosmos SDK Msg type URL.

However, consider changing "any valid Cosmos SDK Msg type url" to "a valid Cosmos SDK Msg type url" for better grammar.

Tools

LanguageTool

[uncategorized] ~288-~288: “any” seems less likely than “a”.
Context: ...cAuthorization). > Note: msg-type is any valid Cosmos SDK Msg type url. Examp...

(AI_HYDRA_LEO_CP_ANY_AN)

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bd52dcf and a5554c3.

Files selected for processing (1)

• x/authz/README.md (2 hunks)

Additional context used

Path-based instructions (1)

x/authz/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool

x/authz/README.md

[uncategorized] ~87-~87: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ens` that keeps track of a limit to the amount of tokens that can be delegated/undeleg...

(AMOUNTOF_TO_NUMBEROF)

---

[uncategorized] ~288-~288: “any” seems less likely than “a”.
Context: ...cAuthorization). > Note: msg-type is any valid Cosmos SDK Msg type url. Examp...

(AI_HYDRA_LEO_CP_ANY_AN)

Markdownlint

x/authz/README.md

279-279: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

286-286: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

294-294: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

---

285-285: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

291-291: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

293-293: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

279-279: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

286-286: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

294-294: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

294-294: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

279-279: Expected: #sendauthorization; Actual: #SendAuthorization
Link fragments should be valid

(MD051, link-fragments)

---

286-286: Expected: #genericauthorization; Actual: #GenericAuthorization
Link fragments should be valid

(MD051, link-fragments)

---

294-294: Expected: #stakeauthorization; Actual: #StakeAuthorization
Link fragments should be valid

(MD051, link-fragments)

Additional comments not posted (1)

x/authz/README.md (1)

297-300: Example for granting delegate authorization type looks good!

The provided example clearly shows how to use the CLI command to grant the delegate authorization type with the relevant optional flags.

[julienrbrt]

lgtm!

[akhilkumarpilli]

lgtm