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

chore(cli): make cli display docs correctly #14017

Merged
bkchr merged 2 commits into from
Apr 27, 2023
Merged

chore(cli): make cli display docs correctly #14017

bkchr merged 2 commits into from
Apr 27, 2023

Conversation

@yjhmelody
Copy link
Contributor

@yjhmelody yjhmelody commented Apr 26, 2023

So many docs not present in cli binary.
clap now ignores documents below blank lines.
So we need to delete these blank lines.

polkadot address: 15ouFh2SHpGbHtDPsJ6cXQfes9Cx1gEFnJJsJVqPGzBSTudr

@bkchr
Copy link
Member

bkchr commented Apr 26, 2023

bot fmt

@command-bot
Copy link

command-bot bot commented Apr 26, 2023 •
edited
Loading

@bkchr https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/2738908 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/substrate/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 6-ce693492-c2ac-4c57-bebe-392a4eb0b4d6 to cancel this command or bot cancel to cancel all commands in this pull request.

@bkchr bkchr requested a review from skunert April 26, 2023 22:49
@bkchr bkchr added B0-silent Changes should not be mentioned in any release notes 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 A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). labels Apr 26, 2023
@command-bot
Copy link

command-bot bot commented Apr 26, 2023

@bkchr Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/2738908 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/2738908/artifacts/download.

@bkchr bkchr merged commit 04248e2 into paritytech:master Apr 27, 2023
@koushiro
Copy link
Contributor

koushiro commented Apr 27, 2023 •
edited
Loading

For the latest version of clap, the --help option will display all doc, but the -h option will only display the first paragraph of the doc, so there is no need to delete these blank lines.

@bkchr
Copy link
Member

bkchr commented Apr 27, 2023

😕

Okay, so we should revert this.. Ty @koushiro for making us aware!

gpestana pushed a commit that referenced this pull request May 4, 2023
@yjhmelody @gpestana
chore(cli): make cli display docs correctly (#14017)
49f69e4 
* chore(cli): make cli display docs correctly

* ".git/.scripts/commands/fmt/fmt.sh"

---------

Co-authored-by: command-bot <>
@kacperzuk-neti kacperzuk-neti mentioned this pull request Jun 23, 2023
Merged
15 tasks
nathanwhit pushed a commit to nathanwhit/substrate that referenced this pull request Jul 19, 2023
@yjhmelody @nathanwhit
chore(cli): make cli display docs correctly (paritytech#14017)
78b01a7 
* chore(cli): make cli display docs correctly

* ".git/.scripts/commands/fmt/fmt.sh"

---------

Co-authored-by: command-bot <>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

2 more reviewers

@skunert skunert skunert approved these changes

@bkchr bkchr bkchr approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes 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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@yjhmelody @bkchr @koushiro @skunert