Skip to content

Improve inline documentation for primary abstractions #123

Open
@Lucaweihs

Description

@Lucaweihs

Problem

All of our primary abstractions should have good documentation and be fully typed.

Solution

Go through all of these critical files and ensure that:

  1. All classes/methods/modules have doc strings and these doc strings enumerate all the parameters if relevant.
  2. All (except in rare cases where doing so would be highly unpractical) parameters are typed.

Dependencies

None

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions