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

Document the doc string concepts in Reference #7

Open
callendorph opened this issue Jul 18, 2023 · 1 comment
Open

Document the doc string concepts in Reference #7

callendorph opened this issue Jul 18, 2023 · 1 comment

Comments

@callendorph
Copy link
Contributor

Currently I think there is syntax like:

doc:  \<doc>


   Markdown Content here 

<doc>

That defines a method of defining documentation related to a function or other object. This is not discussed in the reference from what I can tell.
@CuppoJava
Copy link
Contributor

Agreed, the document generation system hasn't been finished, and the original plan was to report how to use this system once it's "released".

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
2 participants
@callendorph @CuppoJava