Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre & post tasks to help output #860

Open
dflock opened this issue May 13, 2022 · 1 comment
Open

Add pre & post tasks to help output #860

dflock opened this issue May 13, 2022 · 1 comment

Comments

@dflock
Copy link

dflock commented May 13, 2022

It would be great if the help output for a task could include a list of pre & post tasks that this task calls. For example, if I have a serve task, that calls clean & build as pre-tasks, the help output could look something like this:

inv --help serve

Usage: inv[oke] [--core-opts] serve [other tasks here ...]

Docstring:
  Serve thing at http://localhost:$DOCS_PORT/ & live reload on changes. Default port: 5500

Options:
  none

Pre-tasks:
  Calls clean, build

Post-tasks:
  none

Invoke does know this information, and it would be great to make it visible to users so they know what running a task will do - without having to look at the tasks.py code - on manually having to add this text to the docstring.

@neozenith
Copy link

Great suggestion. If you or anyone reading this has the bandwidth, opening a PR that references this issue and has appropriate test coverage would be much appreciated.

Our current priorities are working through dropping Python2 support to reduce our test matrix before addressing a backlog of issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants