Repository navigation
docs: generate reports a tree, and --list is the per-file form - #30
Merged
Merged
Conversation
cli#61 made the tree how `generate` reports its output rather than something only `--dry-run` drew, and added `--list` for the one-line-per-file form. `check-cli-drift.py` caught `--list` missing from `cli.md`, which is also what kept this out of the same PR - the check compares the page against the installed binary, so the flag had to ship first. The guide's "Running it" section showed neither `--dry-run` nor the tree, so it gains both, plus what `--list` has that a tree can't show: the schema each file came from, and the package version when several are generated at once.
This file contains hidden or 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
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.
Follows cli#61, which made
the tree how
generatereports its output — it previously existed only under--dry-run— and added--listfor the one-line-per-file form.Held back from that PR on purpose:
scripts/check-cli-drift.pycomparescli.mdagainst the installed binary, so documenting--listbefore theflag shipped would have failed the check. It duly caught it afterwards:
Both drift scripts are clean now.
cli.md--listadded to the flag list, and the--dry-runsentence rewritten — itclaimed
--dry-runwas what produced the tree, which is no longer whateither flag does.
generating-code.mdThe "Running it" section showed neither
--dry-runnor what the outputactually looks like, so it gains the tree and an example line for the flag.
Plus the part worth knowing:
--listnames the schema each file came from(
api.ids → generated/rust/api.rs) and the package version when several aregenerated at once, neither of which a tree of destinations can show — and
the two flags are independent, one deciding whether anything is written and
the other how it's reported.