Add commands cookbook to cargo-shuttle --help #985
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a couple of example `cookbook` style commands to the `--help` subcommand of `cargo-shuttle`. It took some time for me to realise the difference between `deploy` and `deployments`, or to discover that I could watch my logs in real time via `logs --follow`. My hope is that this extended help assists newcomers in figuring out what cargo-shuttle can do.
|
I agree that having cookbook examples in the help command is too much, but such a list of common ways to use commands are a good addition to the docs page. The link to the docs page can be included here. |
|
Ahh okay yeah this seems best. I'll ammend the PR to include a link to the docs page, and add a cookbook section to the docs. |
|
@beyarkay The comment you have now does not appear in the help output. The general description at the top of help page is taken from cargo-shuttle/Cargo.toml. |
|
Ahh this was a sneaky line to find. #[derive(Parser)]
#[command(
version,
- about,
// Cargo passes in the subcommand name to the invoked executable. Use a
// hidden, optional positional argument to deal with it.
arg(clap::Arg::new("dummy")
.value_parser([PossibleValue::new("shuttle")])
.required(false)
.hide(true))
)]
pub struct Args {
#[command(flatten)]
pub project_args: ProjectArgs, |
AlphaKeks
pushed a commit
to AlphaKeks/shuttle
that referenced
this pull request
Jun 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a couple of example
cookbookstyle commands to the--helpsubcommand ofcargo-shuttle.Description of change
It took some time for me to realise the difference between
deployanddeployments, or to discover that I could watch my logs in real time vialogs --follow. My hope is that this extended help assists newcomers in figuring out what cargo-shuttle can do.As a side note, I understand that this adds a bit of bloat to the help command, and maybe this sort of information is better off somewhere in the docs or in the descriptions for each of the subcommands, so feel free to close this PR if it does not fit in with the overall goals of where information should be.