Skip to content

Commit

Permalink
Reformat docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
nailend committed Jul 31, 2023
1 parent 0047078 commit be92721
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/oemof/solph/_plumbing.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@


def sequence(iterable_or_scalar):
"""This function checks whether an object is a mutable or immutable
iterable (excluding strings) or a scalar. If the object is a mutable
"""
This function checks whether an object is a mutable or immutable
iterable (excluding strings) or a scalar.
If the object is a mutable
iterable, it returns the original sequence. For a scalar or string object,
it returns an 'emulated' sequence object of the class _Sequence with a
default value. If the object is an immutable iterable, it returns an
default value.
If the object is an immutable iterable, it returns an
'emulated' sequence object of class _Sequence with periodic values, and
the total length is determined by the first value of the iterable.
Expand Down

0 comments on commit be92721

Please sign in to comment.