Repository navigation
docs: Clarify CLI options and configuration output - #6966
Open
Hanabi9249 wants to merge 1 commit into
Open
Hanabi9249 wants to merge 1 commit into
Hanabi9249 wants to merge 1 commit into
Conversation
Signed-off-by: Hanabi <3666353208@qq.com>
Contributor
Author
|
Could a CLI maintainer review the configuration-path precedence and the explanation of fields omitted by |
This branch has not been deployed
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
1 participant
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.
What this PR does / why we need it:
The CLI reference omits the existing YAML file-selection and logging options and does not explain that
feast configurationomits unset fields. This can leave users unclear about which configuration file is selected or why an effective default is absent from the output.Document the global options, their placement and configuration-path precedence. Clarify the configuration dump's default-field limitations and label the YAML example as an excerpt. Only the CLI reference Markdown changes; runtime behavior is unchanged.
Validation: combined patch applies cleanly on master
9d42729d471a611597760284e3feaf61e000ca0c;git diff --cached --checkpasses. The option and serialization contracts were checked against the unchanged CLI/RepoConfig source, and the YAML example was parsed in the original documentation verification. CLI execution, Python tests and the Sphinx build were not run; the local environment lacks Feast/pyarrow, and no dependencies were installed for this documentation change.Open #6903 edits the Global Options introduction for structured output. It addresses a different behavior, but that introduction may need a small textual conflict resolution if it lands first.
Which issue(s) this PR fixes:
No linked issue.
Checks
git commit -s)Testing Strategy
Release notes
NONE