docs: improve the Reference -> Command Line section#609
Merged
gabrielbusta merged 2 commits intomainfrom Jan 2, 2025
Merged
Conversation
gabrielbusta
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #609 +/- ##
=======================================
Coverage 73.34% 73.34%
=======================================
Files 125 125
Lines 10003 10003
Branches 1933 1933
=======================================
Hits 7337 7337
Misses 2342 2342
Partials 324 324 ☔ View full report in Codecov by Sentry. |
ahal
approved these changes
Dec 9, 2024
Collaborator
ahal
left a comment
ahal
left a comment
There was a problem hiding this comment.
This change made me realize that there's probably no good reason for us to expose both the "set" and "graph" versions of each phase as top-level commands. IMO it only adds confusion.
src/taskgraph/main.py
Outdated
| @command( | ||
| "full", help="Show the full taskgraph.", defaults={"graph_attr": "full_task_graph"} | ||
| "full", | ||
| help="Show the full taskgraph. The full taskgraph consists of the full task set, with edges (dependencies) between tasks.", |
Collaborator
There was a problem hiding this comment.
nit: s/taskgraph/task graph
While we're making things less confusing, let's make it clear that we're not talking about the package here. Note this comment applies to all the commands.
Collaborator
|
Filed #612 for my thought. |
gabrielbusta
force-pushed
the
gabriel-improved-cli-docs
branch
from
deeb281 to
6e36df5
Compare
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
2 participants
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.
Found myself browsing the codebase after reading reference/cli.html. Thought it'd be good to add more information about what the taskgraph sub-commands represent on this page.