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.

Sign up for GitHub

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

Jump to bottom

Add docstrings to our bash scripts #924

Open
ocaisa opened this issue Feb 21, 2025 · 0 comments
Open

Add docstrings to our bash scripts #924

ocaisa opened this issue Feb 21, 2025 · 0 comments

Comments

@ocaisa
Copy link
Member

ocaisa commented Feb 21, 2025

I haven't used it, but mkdocstrings supports https://mkdocstrings.github.io/shell/, which would give us a way to make our bash scripts easier to browse (syntax for the "docstrings" is at https://pawamoy.github.io/shellman/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ocaisa