cosmos / gaia

Cosmos Hub
https://hub.cosmos.network
Apache License 2.0
462 stars 677 forks source link

[Docs]: Confusing phrasing for `--x-crisis-skip-assert-invariants` #3298

Open rootulp opened 2 weeks ago

rootulp commented 2 weeks ago

Summary

On this page:

To run a node with these checks start your node with the --x-crisis-skip-assert-invariants flag:

However, the help docs for the CLI state:

      --x-crisis-skip-assert-invariants                 Skip x/crisis invariants check on startup

so there appears to be a contradiction here. The docs website claim that to run the checks, provide the flag. The CLI docs claim that to skip the checks, provide the flag. Which is it?

MSalopek commented 2 weeks ago

Thanks for opening the issue and flagging!

The help string is correct, we'll fix the docs with your suggestions.