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 a command to print the full docstring of a session #694

Open
ThomasLaPiana opened this issue Feb 28, 2023 · 0 comments
Open

Add a command to print the full docstring of a session #694

ThomasLaPiana opened this issue Feb 28, 2023 · 0 comments

Comments

@ThomasLaPiana
Copy link

ThomasLaPiana commented Feb 28, 2023

How would this feature be useful?

When a project has a lot of tasks, particularly tasks that developers might use as part of the development flow, it can be helpful to show a more verbose help message than the one provided via nox --list

Describe the solution you'd like

A command, maybe something like nox [--usage|-u] <session> that would print the full docstring of the session function

Describe alternatives you've considered

I wrote a hacky version of this for our own project, where usage is actually another session that prints the docstring of another session. It works, but this seems like a useful feature to have built-in

https://github.com/ethyca/fides/blob/main/noxfile.py#L30-L44

Anything else?

Thanks for making such a great tool, it's been a great replacement for Make 🙂

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

No branches or pull requests

1 participant