Skip to content

Commit

Permalink
More docstring updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ppinchuk committed Feb 13, 2025
1 parent 9b4130f commit 14a0f11
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions reV/generation/generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,14 +350,18 @@ def __init__(
By default, ``None``.
curtailment : dict | str, optional
Inputs for curtailment parameters, which can be:
- Dictionary mapping curtailment "names" to A) strings
(paths) or B) explicit namespaces of curtailment
configurations (dicts)
- Single pointer to curtailment config file with path
(str). In this case, the curtailment config is given
a "default" name.
Input for curtailment parameters, which can be one of:
- Single string representing path to curtailment config
file. In this case, the curtailment config is given
the name "default" and applied everywhere (if the
project points "curtailment" column is missing or all
``None``) or only where the project points
"curtailment" column contains a value of "default"
- Dictionary mapping user-defined curtailment "names" to
either A) strings (paths) or B) explicit namespaces of
curtailment configurations (dicts). Mixing these two
_is_ allowed.
The allowed key-value input pairs in the curtailment
configuration are documented as properties of the
Expand Down

0 comments on commit 14a0f11

Please sign in to comment.