Skip to content

Commit

Permalink
Adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Jul 29, 2024
1 parent 04e4a62 commit 51cd2ff
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,21 +74,10 @@ apply the algorithm
and all return the same result
as a :class:`pandas.Series`.

>>> interface.process_files(files, root=db.root)
file start end
wav/03a01Fa.wav 0 days 0 days 00:00:01.898250 -21.6901
wav/03a01Nc.wav 0 days 0 days 00:00:01.611250 -18.0407
wav/16b10Wb.wav 0 days 0 days 00:00:02.522499999 -20.3945
dtype: float32

>>> interface.process_folder(folder, include_root=False)
file start end
03a01Fa.wav 0 days 0 days 00:00:01.898250 -21.6901
03a01Nc.wav 0 days 0 days 00:00:01.611250 -18.0407
16b10Wb.wav 0 days 0 days 00:00:02.522499999 -20.3945
dtype: float32

>>> interface.process_index(index, root=db.root)
>>> y = interface.process_files(files, root=db.root)
>>> y = interface.process_folder(folder, include_root=False)
>>> y = interface.process_index(index, root=db.root)
>>> y
file start end
wav/03a01Fa.wav 0 days 0 days 00:00:01.898250 -21.6901
wav/03a01Nc.wav 0 days 0 days 00:00:01.611250 -18.0407
Expand Down

0 comments on commit 51cd2ff

Please sign in to comment.