docs: add additional field 'fromfile' for options in the help-all goal output #17944
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
AlexTereshenkov
added
the
category:internal
kaos
previously approved these changes
Jan 7, 2023
kaos
approved these changes
Jan 8, 2023
AlexTereshenkov
deleted the
docs/extend-help-goal-with-fromfile-property
branch
cczona
pushed a commit
to cczona/pants
that referenced
this pull request
Jan 9, 2023
…l output (pantsbuild#17944) * docs: add additional field 'fromfile' for options in the help-all goal output * Reword * Fix tests * Improve wording
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.
Extend the
help-alloutput by including an additional fieldfromfile. There are currently three options where one can either provide adictor a file path from where the value will be read; the file path is provided as text with@filepathnotation.This information is needed for the JSON schema generation in #17895 as such options would allow two types:
["some-type", "string"]