DOC: Add descriptions to the Pixi tasks#2508
Merged
VeckoTheGecko merged 1 commit intoParcels-code:v4-devfrom Feb 11, 2026
Merged
DOC: Add descriptions to the Pixi tasks#2508VeckoTheGecko merged 1 commit intoParcels-code:v4-devfrom
VeckoTheGecko merged 1 commit intoParcels-code:v4-devfrom
Conversation
Member
erikvansebille
left a comment
There was a problem hiding this comment.
Looks very good! Only comment would be that I find the table header =(Task. Description) a bit confusingly formatted now, between the full list of tasks and the rows of the table. Can that header row be removed? I think it's self-explanatory?
And do we also need the first line with all the tasks?
A shorter version would then be
❯ pixi task list
Tasks that can run on this machine:
-----------------------------------
docs Build the documentation.
docs-linkcheck Verify all links in documentation don't 404.
docs-watch Build and auto-rebuild the documentation on changes.
lint Run all pre-commit linting hooks.
numpydoc-lint Lint public API docstrings with numpydoc.
tests Run the test suite.
tests-notebooks Run the user guide example notebooks as tests.
typing Run static type checking with mypy.
Contributor
Author
Yes, you're right - this is confusing. Hopefully the formatting improves with future versions of pixi - but this is out of our control on our end |
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.
Fixes None
Before:
After:
Feel free to make any edits @erikvansebille - I feel like this makes things a lot more accessible for new devs :)