Helmholtz-AI-Energy / Helmholtz-AI-Energy/propulate

Add "Examples" section and references to parent modules / classes to docstrings.

Open
#56 2 comments 0 reactions 1 assignee Claimed by @mcw92 View on GitHub
documentation
Dominant language
Python
Stars
46
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Doc strings should have the following subsections:
- Parameters
- Returns
- Raises
- Examples

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.