Skip to content

Help writer improvements#1252

Closed
FrankRay78 wants to merge 3 commits intospectreconsole:mainfrom
FrankRay78:Help-Writer-Improvements
Closed

Help writer improvements#1252
FrankRay78 wants to merge 3 commits intospectreconsole:mainfrom
FrankRay78:Help-Writer-Improvements

Conversation

@FrankRay78
Copy link
Copy Markdown
Contributor

@FrankRay78 FrankRay78 commented Jul 5, 2023

Summary of changes

Version option will show in help even with a default command

Reserve -v and --version as special spectre.console command line arguments (nb. breaking change for spectre.console users who have a default command with a settings class that uses either of these switches)

Help writer correctly determines if trailing commands exist and whether to display them as optional or mandatory in the usage statement

Ability to control the number of indirect commands to display in the help text when the command itself doesn't have any examples of its own. Defaults to 5 (for backward compatibility) but can be set to any integer or zero to disable completely.

Significant increase in unit test coverage for the help writer

Minor grammatical improvements to website documentation

Version option will show in help even with a default command

Reserve `-v` and `--version` as special spectre.console command line arguments (nb. breaking change for spectre.console users who have a default command with a settings class that uses either of these switches)

Help writer correctly determines if trailing commands exist and whether to display them as optional or mandatory in the usage statement

Ability to control the number of indirect commands to display in the help text when the command itself doesn't have any examples of its own. Defaults to 5 (for backward compatibility) but can be set to any integer or zero to disable completely.

Significant increase in unit test coverage for the help writer

Minor grammatical improvements to website documentation
@FrankRay78
Copy link
Copy Markdown
Contributor Author

DON'T MERGE THIS PR
I propose to merge the changes in this PR through it's ancestor PR #1259 (once merged, I will delete this PR)

@patriksvensson patriksvensson marked this pull request as draft August 6, 2023 19:11
@patriksvensson
Copy link
Copy Markdown
Contributor

@FrankRay78 I've converted this PR to a draft so it won't be accidentally merged

@FrankRay78 FrankRay78 closed this Sep 13, 2023
@patriksvensson patriksvensson removed this from the 0.48 milestone Sep 17, 2023
@FrankRay78 FrankRay78 deleted the Help-Writer-Improvements branch September 21, 2023 09:30
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.

--version not showing version when default command set Showing Mutiple Examples Don't show command examples at root

2 participants