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

instructions to documentation syntax #48

Open
meleu opened this issue May 24, 2022 · 2 comments
Open

instructions to documentation syntax #48

meleu opened this issue May 24, 2022 · 2 comments
Assignees
@andyone
Labels
issue • question

Comments

@meleu
Copy link

meleu commented May 24, 2022

I'm a bit confused about how I should write the comments in my scripts so shdoc can parse them as documentation.

The demo in the gif looks exciting, but I didn't find any instruction/example in the README.

Thanks in advance! ❤️
@andyone andyone self-assigned this May 24, 2022
@andyone
Copy link
Member

andyone commented May 24, 2022

Hi! The best example with documentation for shdoc is kaosv sources.

A little bit later I will add a wiki page with instructions on how to write comments with documentation.

@docwhat
Copy link

docwhat commented Jun 25, 2024

Is it "a little bit later", now? 😃

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

@andyone andyone

Labels
issue • question
Milestone
No milestone
Development

No branches or pull requests
3 participants
@docwhat @andyone @meleu