Open MarcSkovMadsen opened 3 months ago
-1 on this, as @hoxbro explains in #7218 the naming is deliberately hierarchical, i.e. docs related tasks are prefixed with docs, test related tasks are prefixed with test and build related tasks are prefixed with build. The fact that pixi provides tab-completion in fact makes this argument stronger as you can see all related option by typing build, docs, and test and then tabbing.
With @hoxbro and I aligned on this I'm going to close.
But you build the docs? What does build mean to you?
I can build. I can test. But i cannot docs - I can build my docs though.
I get the confusion but the build
prefix is not meant to be read as a verb but rather as a category of tasks, specifically tasks related to building packages. Just as test
-prefixed tasks are tasks related to testing and docs
-prefixed tasks are tasks related to generating documentation materials.
I'd be fine renaming build
to pkg
or something to reduce the confusion.
If we want to avoid the verb
confusion entirely we should also rename test
-> tests
.
I don't know why you think the first word must be a verb.
The naming of build
and test
is a common word for building and testing purposes.
The docs
name is more uncommon but not unheard of.
As @philippjfr mentioned, autocomplete also strengthens the current ordering of having the main category first and then subsections related to it, as you can easily see what tasks are available for each main category.
I'm still -1 on the proposed change made in this issue.
To me you logically "build docs". Just like you build Python packages, build npm packages etc. There is no difference.
For example you use the sphinx-build command to build docs.
To be consistent you should then call it conda-build, npm-build etc.
The names of the
pixi
tasks areI can see that they all start with with a verb and then a name, except the
docs-build
anddocs-server
.Please rename to
build-docs
andserve-docs
, to make things consistent, easier to discover and easier to remember.If
pixi
can do tab completion, then this will also be a big advantage.