Change shdoc style to mkdocstrings format
Maintainers usually reply within 1 day
@JonathanTSilva is already working on this.
Since Aug 8, 2025.
Assessment
This issue has not been assessed yet.
Description
It would be interesting if shdoc generated bash documentation to be interpreted by the project documentation with mkdocstring. To do this, you might need to change the bash file comment documentation to something similar to the Google Python Style docstring.
- Dominant language
- Shell
- Stars
- 0
- Forks
- 0
- Avg merge
- 8h 41m
- Merged PRs (30d)
- 9
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from JonathanTSilva/scriptize
-
type: chore
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
Update all the demonstration of utilities to a test fileMay be free again @JonathanTSilva claimed this 501 days ago, and no pull request is open. Openenhancement
JonathanTSilva/scriptize#1 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in JonathanTSilva/scriptize
Similar issues
-
type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
nightgauge/nightgauge#3480 ·
Maintainers usually reply within 1 day
-
data only (no code) documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
awaiting-response backend bug documentation P3 platform/linux qa
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
wildcard/caro#1778 · 1 comment ·
Maintainers usually reply within 7 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ehmpathy/rhachet-roles-ehmpathy#1437 ·
Maintainers usually reply within 1 day
-
bug ready
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
MartinPTielemans/ilo#3805 ·
Maintainers usually reply within 1 day