-
Notifications
You must be signed in to change notification settings - Fork 0
Style Guide: SCDocs (.schelp)
The following guidelines apply to schelp files in /HelpSource
.
Prefer using the lowercase forms of tags (code:: ::
, method::
), unless this would break with convention in the context being edited.
Use tabs for indentation, both for schelp-formatted text and code examples.
Hide all of a class's private methods using private::
.
Prefer using argument::
and returns::
instead of the method description body to document parameters and return values.
Either all of the parameters and/or return value should be documented, or none should be.
When documenting a parameter or return value, make sure to include the expected type.
Contributing
Contributing to the project, filing bugs, creating pull requests, style guidelines.
Development resources
Project documentation, structure, reviewing, releasing, and other processes.
User resources
FAQ, resources for learning, tutorial lists.
Community
Forums and communication, community projects, artworks and initiatives, info about the SuperCollider project.