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 usage session for Nox commands #1618

Closed
ThomasLaPiana opened this issue Oct 31, 2022 · 0 comments · Fixed by #2022
Closed

Add usage session for Nox commands #1618

ThomasLaPiana opened this issue Oct 31, 2022 · 0 comments · Fixed by #2022
Assignees
Labels
dev experience Targets the developer experience documentation Improvements or additions to documentation

Comments

@ThomasLaPiana
Copy link
Contributor

ThomasLaPiana commented Oct 31, 2022

Docs Update Description

While we can currently use nox to get a list of available session, this is often not sufficient as it will only show the first line of the docstring, and we use more lines to document usage of posargs, etc.

The ideal functionality here would be:

nox -s usage -- <session_name>

with the output being the docstring of the session.

Full example:

fides> nox -s usage -- build

    Build the Docker containers.

    Params:
    dev - Build the dev containers tagged as 'local'
    prod - Build the container tagged as the version of the application
@ThomasLaPiana ThomasLaPiana added the documentation Improvements or additions to documentation label Oct 31, 2022
@ThomasLaPiana ThomasLaPiana self-assigned this Oct 31, 2022
@ThomasLaPiana ThomasLaPiana changed the title Add some kind of usage session for Nox commands Add usage session for Nox commands Oct 31, 2022
@ThomasLaPiana ThomasLaPiana added the dev experience Targets the developer experience label Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev experience Targets the developer experience documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant