Skip to content

docs: improve UpdateProposer script documentation #253

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

crStiv
Copy link

@crStiv crStiv commented Jan 20, 2025

Improved documentation in UpdateProposer.s.sol:

  • Added complete NatSpec documentation describing script purpose
  • Added detailed description of all required environment variables
  • Enhanced state variable comments
  • Made prerequisites more informative and clear

These changes make the code more maintainable and easier to use by other developers by clearly documenting all required environment variables and prerequisites for script execution.

@cb-heimdall
Copy link
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@wbnns wbnns added the base protocol review To be reviewed by the Base web team label Apr 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
base protocol review To be reviewed by the Base web team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants