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: improve bor server --help #1063

Merged
merged 11 commits into from
Nov 7, 2023
Merged

chore: improve bor server --help #1063

merged 11 commits into from
Nov 7, 2023

Conversation

leovct
Copy link
Contributor

@leovct leovct commented Oct 26, 2023

Description

  • Sort flags in bor server --help.

This is before the fix.

Screenshot 2023-10-26 at 21 03 47

This is after the fix.

Screenshot 2023-10-26 at 21 04 34

  • Clean up flag descriptions by removing redundant default values.
# example for `txarrivalwait` flag
# before
$ bor server --help
...
-txarrivalwait
    Maximum duration to wait for a transaction before explicitly requesting it (defaults to 500ms) (default: 500ms)

# after
$ bor server --help
...
-txarrivalwait
    Maximum duration to wait for a transaction before explicitly requesting it (default: 500ms)
...
  • Update docs using make docs. I've seen that docs haven't been updated since a long time, I can make a follow-up PR with a CI job if you guys want :)

Changes

  • Bugfix (non-breaking change that solves an issue)
  • Hotfix (change that solves an urgent issue, and requires immediate attention)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (change that is not backwards-compatible and/or changes current functionality)
  • Changes only for a subset of nodes

Breaking changes

Please complete this section if any breaking changes have been made, otherwise delete it

Nodes audience

In case this PR includes changes that must be applied only to a subset of nodes, please specify how you handled it (e.g. by adding a flag with a default value...)

Checklist

  • I have added at least 2 reviewer or the whole pos-v1 team
  • I have added sufficient documentation in code
  • I will be resolving comments - if any - by pushing each fix in a separate commit and linking the commit hash in the comment reply
  • Created a task in Jira and informed the team for implementation in Erigon client (if applicable)
  • Includes RPC methods changes, and the Notion documentation has been updated

Cross repository changes

  • This PR requires changes to heimdall
    • In case link the PR here:
  • This PR requires changes to matic-cli
    • In case link the PR here:

Testing

  • I have added unit tests
  • I have added tests to CI
  • I have tested this code manually on local environment
  • I have tested this code manually on remote devnet using express-cli
  • I have tested this code manually on mumbai
  • I have created new e2e tests into express-cli

Manual tests

Please complete this section with the steps you performed if you ran manual tests for this functionality, otherwise delete it

Additional comments

Please post additional comments in this section if you have them, otherwise delete it

@leovct leovct changed the title chore: update txarrivalwait flag description chore: remove redundant defaults from bor server flags description Oct 26, 2023
@leovct leovct changed the title chore: remove redundant defaults from bor server flags description chore: improve bor server --help Oct 26, 2023
@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

Attention: 14 lines in your changes are missing coverage. Please review.

Files Coverage Δ
internal/cli/server/flags.go 100.00% <100.00%> (ø)
internal/cli/flagset/flagset.go 45.33% <0.00%> (-1.98%) ⬇️

... and 21 files with indirect coverage changes

📢 Thoughts on this report? Let us know!

Copy link
Member

@pratikspatil024 pratikspatil024 left a comment

Choose a reason for hiding this comment

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

Thank you!

@manav2401 manav2401 changed the base branch from master to develop November 7, 2023 04:48
@manav2401 manav2401 merged commit 22a2b63 into maticnetwork:develop Nov 7, 2023
12 of 14 checks passed
@leovct leovct deleted the leovct/chore-update-txarrivalwait-flag-description branch November 7, 2023 07:18
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