chore: CLI help message explains include flags#4431
Merged
Conversation
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The logic that detects include flags is hard-coded to names starting with
include_; consider centralizing this convention (e.g., a helper or shared predicate) so that future endpoints or naming changes don't silently break the include guidance. - In
printEndpointHelp, the line" This does not mean the data does not exist; it simply was not preloaded.\n"introduces an embedded newline unlike the surrounding lines; removing the\nand relying on thejoin("\n")behavior would keep formatting consistent and avoid unexpected extra blank lines.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The logic that detects include flags is hard-coded to names starting with `include_`; consider centralizing this convention (e.g., a helper or shared predicate) so that future endpoints or naming changes don't silently break the include guidance.
- In `printEndpointHelp`, the line `" This does not mean the data does not exist; it simply was not preloaded.\n"` introduces an embedded newline unlike the surrounding lines; removing the `\n` and relying on the `join("\n")` behavior would keep formatting consistent and avoid unexpected extra blank lines.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: Adriano Lazzaretti <lazzaretti136@gmail.com>
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.
No description provided.