Skip to content

Documentation Consistency  #93

@skygering

Description

@skygering

It would be great to have a file with definitions of various simulation components that are passed around. These strings could be made into constants and then used within the doc strings of functions rather than copy/pasting the same few lines. This would also make it easy to change all of the documentation at once.

Additionally, only user-facing functions should have docstrings. The rest should just have leading comments. These internal functions should also start with an underscore to highlight that they aren't for user-use.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions