Skip to content

Complete DocStrings #16

@cmlccie

Description

@cmlccie

Review modules to ensure every module, function and method is documented with a complete docstring.

For Package & Modules - DocStrings should...

  • Enumerate the package's or modules's exposed API; providing simple 1-2 sentence descriptions.
  • Call out any notable requirements or key pieces of information when using the package / module.

For Classes, Functions & Methods - DocStrings should...

  • Provide a simple 1-sentence description describing purpose / use.
  • Provide a more complete description of use if needed.
  • Enumerate attributes, arguments, return types, and exceptions raised.

All DocStrings should use the Imperative Tense or Mood, and should use package consistent formatting (intent is to use an auto-generation tool to assist with package documentation).

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions