Skip to content

Commit

Permalink
minor docs fixes to coreInsert
Browse files Browse the repository at this point in the history
  • Loading branch information
mscuthbert committed Mar 30, 2023
1 parent 37763c4 commit 9011556
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions music21/stream/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def coreInsert(
*,
ignoreSort=False,
setActiveSite=True
):
) -> bool:
'''
N.B. -- a "core" method, not to be used by general users. Run .insert() instead.
Expand All @@ -91,7 +91,9 @@ def coreInsert(
Do not mix coreInsert with coreAppend operations.
Returns boolean if the Stream is now sorted.
Returns boolean if the Stream (assuming it was sorted before) is still guaranteed
to be sorted. (False doesn't mean that it's not sorted, just that we can't guarantee it.)
If you don't care and plan to sort the stream later, then use `ignoreSort=True`.
'''
# environLocal.printDebug(['coreInsert', 'self', self,
# 'offset', offset, 'element', element])
Expand Down Expand Up @@ -135,7 +137,7 @@ def coreAppend(
element: Music21Object,
*,
setActiveSite=True
):
) -> None:
'''
N.B. -- a "core" method, not to be used by general users. Run .append() instead.
Expand Down Expand Up @@ -170,7 +172,7 @@ def coreSetElementOffset(
*,
addElement=False,
setActiveSite=True
):
) -> None:
'''
Sets the Offset for an element, very quickly.
Caller is responsible for calling :meth:`~music21.stream.core.coreElementsChanged`
Expand Down

0 comments on commit 9011556

Please sign in to comment.