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

Make option syntax clear and consistent #1722

Open
alexandratran opened this issue Oct 22, 2024 · 0 comments
Open

Make option syntax clear and consistent #1722

alexandratran opened this issue Oct 22, 2024 · 0 comments

Comments

@alexandratran
Copy link
Contributor

There are some inconsistencies with how we present the syntax of various CLI options in the reference. For example:

--rpc-http-tls-cipher-suite=<cipherSuiteName>[, <cipherSuiteName>...]

--bootnodes[=<enode://id@host:port>[,<enode://id@host:port>...]...]

--net-restrict=<subnet>[,<subnet>,...]

--banned-node-ids=<bannedNodeId>[,<bannedNodeId>...]...

These are some inconsistent examples of how we denote comma-separated lists, and there are still other variants. Also, we currently use square brackets to denote an optional value, but some options might require using square brackets for arrays, which could cause confusion. We should decide on a consistent and clear way to document these types of options.

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

No branches or pull requests

1 participant