Skip to content

Commit

Permalink
Reflow docstrings in .util
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed Apr 1, 2021
1 parent f877aab commit d0b3a77
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions message_ix_models/util/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,8 @@ def copy_column(column_name):
Examples
--------
Modify `df` by filling the column 'baz' with the value ``3``, and copying
the column 'bar' into column 'foo'.
Modify `df` by filling the column 'baz' with the value ``3``, and copying the column
'bar' into column 'foo'.
>>> df.assign(foo=copy_column('bar'), baz=3)
"""
Expand Down Expand Up @@ -354,9 +354,8 @@ def make_io(src, dest, efficiency, on="input", **kwargs):
efficiency : float
Conversion efficiency.
on : 'input' or 'output'
If 'input', `efficiency` applies to the input, and the output, thus the
activity level of the technology, is in dest[2] units. If 'output',
the opposite.
If 'input', `efficiency` applies to the input, and the output, thus the activity
level of the technology, is in dest[2] units. If 'output', the opposite.
kwargs
Passed to :func:`make_df`.
Expand Down Expand Up @@ -389,11 +388,11 @@ def make_matched_dfs(base, **par_value):
"""Return data frames derived from *base* for multiple parameters.
*par_values* maps from parameter names (e.g. 'fix_cost') to values.
make_matched_dfs returns a :class:`dict` of :class:`pandas.DataFrame`, one
for each parameter in *par_value*. The contents of *base* are used to
populate the columns of each data frame, and the values of *par_value*
overwrite the 'value' column. Duplicates—which occur when the target
parameter has fewer dimensions than *base*—are dropped.
make_matched_dfs returns a :class:`dict` of :class:`pandas.DataFrame`, one for each
parameter in *par_value*. The contents of *base* are used to populate the columns
of each data frame, and the values of *par_value* overwrite the 'value' column.
Duplicates—which occur when the target parameter has fewer dimensions than
*base*—are dropped.
Examples
--------
Expand Down

0 comments on commit d0b3a77

Please sign in to comment.