Skip to content

Commit

Permalink
docs: in_place explanation
Browse files Browse the repository at this point in the history
Improve understanding of sort_and_reorder() method by including algorithmic description for parameter 'in_place'.
  • Loading branch information
switchupcb committed May 12, 2021
1 parent 2d9f734 commit ec3cd47
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions srt.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,8 @@ def sort_and_reindex(subtitles, start_index=1, in_place=False, skip=True):
:param int start_index: The index to start from
:param bool in_place: Whether to modify subs in-place for performance
(version <=1.0.0 behaviour)
`https://en.wikipedia.org/wiki/in-place_algorithm
<https://en.wikipedia.org/wiki/in-place_algorithm/>`_.
:param bool skip: Whether to skip subtitles considered not useful (see
above for rules)
:returns: The sorted subtitles
Expand Down

0 comments on commit ec3cd47

Please sign in to comment.