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

docs: mark two params as gov modifiable #3025

Merged
merged 1 commit into from
Jan 22, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Jan 18, 2024

Closes #2972

Copy link
Contributor

coderabbitai bot commented Jan 18, 2024

Walkthrough

Walkthrough

The recent updates involve correcting the specifications to accurately reflect the governance modifiability of certain parameters. The consensus.Version.AppVersion and staking.MaxValidators have been updated to show they are modifiable, while staking.UnbondingTime has been clarified as non-modifiable. Additionally, the mint module documentation now includes a note on governance non-modifiability for specific parameters.

Changes

File(s) Change Summary
specs/.../params.md Marked consensus.Version.AppVersion as modifiable.
specs/.../params.md Marked staking.MaxValidators as modifiable.
specs/.../params.md Marked staking.UnbondingTime as non-modifiable.
specs/.../params.md Added note on governance non-modifiability in the mint module.

Assessment against linked issues

Objective Addressed Explanation
Correct the modifiability status of consensus.Version.AppVersion and staking.MaxValidators (#2972)
Clarify the non-modifiability of staking.UnbondingTime (#2972)
Add a note on governance non-modifiability for parameters in the mint module (#2972)

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@celestia-bot celestia-bot requested a review from a team January 18, 2024 19:38
@rootulp rootulp changed the title specs: mark two params as gov modifiable docs: mark two params as gov modifiable Jan 18, 2024
@evan-forbes
Copy link
Member

what do we think about keeping the param as not modifiable in the specs since we're planning on fixing it for v2?

@rootulp
Copy link
Collaborator Author

rootulp commented Jan 19, 2024

what do we think about keeping the param as not modifiable in the specs since we're planning on fixing it for v2?

I agree we should make this non gov modifiable in v2 but I think the specs should reflect what exists in the protocol rather than what we want. Note: we already fixed this in the living document CIP: celestiaorg/CIPs#43

@rootulp rootulp requested a review from cmwaters January 19, 2024 19:08
@rootulp rootulp enabled auto-merge (squash) January 19, 2024 19:08
@rootulp rootulp merged commit 1fd4b34 into celestiaorg:main Jan 22, 2024
31 of 32 checks passed
@rootulp rootulp deleted the rp/gov-specs branch January 22, 2024 16:55
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.

Parameters that are stated as not governance modifiable, are actually governance modifiable.
4 participants