Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

improve ocw validator/collator CLI description #12931

Merged
merged 3 commits into from
Dec 16, 2022

Conversation

bernardoaraujor
Copy link
Contributor

@bernardoaraujor bernardoaraujor commented Dec 14, 2022

There's many instances on the substrate/cumulus stack where the Validator term is used when Collator should hold the actual meaning. Unfortunately, it's not trivial to solve many of those cases, because of the way that the dependencies of substrate and cumulus are set up.

In case of this CLI argument for OCWs, I propose improving the description string, at least so that the reader has some context to avoid misleading interpretations.

This PR has similar motivations to paritytech/polkadot-sdk#436

@github-actions github-actions bot added the A0-please_review Pull request needs code review. label Dec 14, 2022
@bkchr bkchr added B5-clientnoteworthy C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Dec 14, 2022
client/cli/src/arg_enums.rs Outdated Show resolved Hide resolved
Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
@bkchr bkchr merged commit 5d3624c into master Dec 16, 2022
@bkchr bkchr deleted the bar/improve-cli-description-ocw-validator-collator branch December 16, 2022 08:49
ltfschoen pushed a commit to ltfschoen/substrate that referenced this pull request Feb 22, 2023
* improve ocw validator/collator CLI description

* rename WhenValidating to WhenAuthoring

* Update client/cli/src/arg_enums.rs

Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>

Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
ark0f pushed a commit to gear-tech/substrate that referenced this pull request Feb 27, 2023
* improve ocw validator/collator CLI description

* rename WhenValidating to WhenAuthoring

* Update client/cli/src/arg_enums.rs

Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>

Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants