Doc: Update 'use_git' example #1191
Open
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
|
Any feedback @sassman & @joshrotenberg ? |
sassman
reviewed
Jun 12, 2024
| @@ -40,19 +40,18 @@ Consider the following `cargo-generate.toml` file: | |||
| ```toml | |||
| [placeholders] | |||
| project_name = { prompt = "Enter project name", default = "my_project", type = "string" } | |||
| use_git = { prompt = "Initialize Git repository?", choices = ["Yes", "No"], default = "Yes", type = "boolean" } | |||
| use_git = { prompt = "Initialize Git repository?", default = true, type = "bool" } | |||
There was a problem hiding this comment.
logically you're making sense here. However, the intent was to showcase the choices.
So the better fix would be type = "string"
But maybe we keep this, and add a different example for choices.
sassman
reviewed
Jun 12, 2024
| - `"editor"`: Represents a multiline string value, collected from the user by a real terminal editor. | ||
| - `"boolean"`: Represents a boolean value (`true` or `false`). | ||
| - `"bool"`: Represents a boolean value (`true` or `false`). |
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.
Changes
use_gitexample wherebooleanshould bebooluse_gitexample to removechoicesfieldContext
use_git example
If you attempt to run the
use_gitexample as it is currently you'll receiveAnd, after you change it from
booleantoboolyou'll receiveCTRL-D
The rendered page does not show CTRL-D