Skip to content

Document description field of tasks #4483

@analog-cbarber

Description

@analog-cbarber

Problem description

You can add task help using the description field, but this is not documented nor shown in the task examples:

[tasks.my-task]
cmd = "..."
description = "does something ..."
$ pixi task list
Tasks that can run on this machine
-----------------------------------
my-task ...
Task           Description
my-task     does something ...

This is useful and should be documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:tasksRelated to pixi tasksdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions