fix(graph): fix "args" help tooltip in pdv and only show "args" usage in fallback example #27808
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
leosvelperez
requested review from
philipjfulcher,
FrozenPandaz,
bcabanes,
MaxKless and
xiongemi
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 00cbda7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 4 targets
Sent with 💌 from NxCloud. |
… in fallback example
leosvelperez
force-pushed
the
graph/improve-help-args-description
branch
from
8a9bf95
to
00cbda7
Compare
MaxKless
approved these changes
Sep 9, 2024
FrozenPandaz
pushed a commit
that referenced
this pull request
Sep 9, 2024
… in fallback example (#27808) <!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> The help tooltip for an example using `args` is misleading. It states that `args` are CLI positional arguments, but they can also be CLI flags. Additionally, the fallback example shows an example using `options`, which has a few caveats. ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> The help tooltip for an example using `args` should state that `args` are CLI flags or positional arguments. The fallback example should show only an example using `args` to reduce the likelihood of users bumping into any of the caveats of using `options`, which could be frustrating. Note: a separate change to the docs will be made to explicitly call out these caveats. Users would still be able to use `options`, but it shouldn't be the recommended way of providing args unless they are well aware of the caveats. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes # (cherry picked from commit 27b8649)
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Current Behavior
The help tooltip for an example using
argsis misleading. It states thatargsare CLI positional arguments, but they can also be CLI flags.Additionally, the fallback example shows an example using
options, which has a few caveats.Expected Behavior
The help tooltip for an example using
argsshould state thatargsare CLI flags or positional arguments.The fallback example should show only an example using
argsto reduce the likelihood of users bumping into any of the caveats of usingoptions, which could be frustrating.Note: a separate change to the docs will be made to explicitly call out these caveats. Users would still be able to use
options, but it shouldn't be the recommended way of providing args unless they are well aware of the caveats.Related Issue(s)
Fixes #