Skip to content

Commit

Permalink
Streamline existing API docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
riga committed Mar 11, 2023
1 parent 3671a13 commit 2b2b695
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions order/unique.py
Original file line number Diff line number Diff line change
Expand Up @@ -712,19 +712,19 @@ def __init__(self, *args, **kwargs):
if decorated_cls.__doc__:
decorated_cls.__doc__ += """
.. py:attribute:: {plural}
type: UniqueObjectIndex
read-only
The :py:class:`~order.unique.UniqueObjectIndex` of child {plural}.
type: :py:class:`UniqueObjectIndex` (read-only)
The :py:class:`~order.unique.UniqueObjectIndex` of child {plural}.
""".format(plural=plural)

if parents:
decorated_cls.__doc__ += """
.. py:attribute:: parent_{plural}
type: UniqueObjectIndex
read-only
The :py:class:`~order.unique.UniqueObjectIndex` of parent {plural}.
type: :py:class:`UniqueObjectIndex` (read-only)
The :py:class:`~order.unique.UniqueObjectIndex` of parent {plural}.
""".format(plural=plural)

#
Expand Down

0 comments on commit 2b2b695

Please sign in to comment.