Skip to content

Commit

Permalink
docs: update wording in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon Hagg committed Mar 29, 2022
1 parent d942f4a commit 257fb91
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions powersimdata/input/changes/electrification.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ def _check_scale_factors(scale_factors):

@dataclass
class ScaleFactors:
"""Map profile(s) to adoption rate
"""Map technology to adoption rate
:param dict sf: a dictionary mapping profiles names to adoption rate
:param dict sf: a dictionary mapping tech to adoption rate
"""

sf: Dict[str, float]
Expand Down Expand Up @@ -59,7 +59,8 @@ def value(self):

@dataclass
class ElectrifiedDemand:
"""Container object for specifying profiles within a given class of electrification
"""Container object for specifying zone or grid level adoption of any technologies
for a given class of electrification
:param powersimdata.input.change_table.ChangeTable obj: change table
:param dict info: see :func:`add_electrification`
Expand Down Expand Up @@ -89,7 +90,7 @@ def value(self):


def add_electrification(obj, kind, info):
"""Add profiles and scaling factors for electrified demand.
"""Add electrification profiles
:param powersimdata.input.change_table.ChangeTable obj: change table
:param str kind: the kind of demand, e.g. building
Expand Down

0 comments on commit 257fb91

Please sign in to comment.