docs: Update documentation on task names#4230
Merged
lucascolley merged 4 commits intoprefix-dev:mainfrom Jul 29, 2025
Merged
Conversation
Add a brief section and example of how task names prefixed with _ will be hidden from the output of `pixi run` and `pixi task list`.
ruben-arts
changed the title
Contributor
|
Hey @photex, thanks for helping out! I tried it locally, but there were some typos resulting in the TOML not working/rendering, I also figured that the example might be a little too verbose, so I've tried to slim it down. Hope you're content with my changes. @lucascolley please review it! |
Contributor
Author
|
😅 sorry about that. I’m in a waiting room and didn’t fully try to build everything yet. |
lucascolley
added
documentation
lucascolley
requested changes
Jul 29, 2025
Collaborator
lucascolley
left a comment
lucascolley
left a comment
There was a problem hiding this comment.
nice! One request: could we add a !!! hint in the depends-on section (just one sentence saying you can hide tasks and linking to #task-names)?
Contributor
Author
|
Thanks @lucascolley, I've added a hint as you've suggested. Please let me know if the wording is acceptable. :) |
lucascolley
approved these changes
Jul 29, 2025
Collaborator
lucascolley
left a comment
lucascolley
left a comment
There was a problem hiding this comment.
great stuff, thanks both!
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
3 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.
Add a brief section and example of how task names prefixed with _ will be hidden from the output of
pixi runandpixi task list.closes gh-4129