Skip to content

Commit

Permalink
DOC: add details to _OwnedList's docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
neutrinoceros committed Apr 20, 2024
1 parent f642271 commit 990c546
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions astropy/utils/collections.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,15 @@ class _OwnedList(list):
As of astropy 7.0, direct mutations are considered deprecated so a warning
is emitted. In a future major release of astropy, an actual exception will be
raised instead.
This class may be combined with other list subclasses via multiple inheritance,
in which case it is assumed to appear first on the inheritance chain, e.g.
>>> class _OwnedHomogeneousList(_OwnedList, HomogeneousList):
... pass
otherwise, deprecation messages' might not point to the correct line.
"""

def __init__(
Expand Down

0 comments on commit 990c546

Please sign in to comment.