Skip to content

Document what doc comments/docstrings are good for #20

Description

@vks

The documentation tells you how to create doc comments, but it is not clear what they are good for. Maybe give a hint at how to use them?

(use code documentation)
(print (documentation ...))

It might make sense to have a function help that prints the documentation, like in Python. It would not be terribly useful at the moment, because it seems that the built-in functions and operators don't have docstrings.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions