Skip to content

Commit

Permalink
Update dostring
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Apr 30, 2024
1 parent 9fb118e commit 2730078
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions audbcards/core/datacard.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def file_duration_distribution(self) -> str:
``<cache-root>/<dataset-name>/<dataset-version>/``
and copied to the sphinx source folder
under
``<dataset-name>/``.
``<sphinx-src-dir>/<dataset-name>/``.
The image is displayed inline
between the minimum and maximum values.
If all duration values are the same,
Expand Down Expand Up @@ -178,14 +178,26 @@ def player(self) -> str:
or :attr:`audbcards.Datacard.sphinx_src_dir`
are not ``None``,
an example media file is cached in the folder
``${cache_root}/{name}-{version}-player-media/``,
``<dataset-name>-<dataset-version>-player-media/``
inside
``<cache-root>/<dataset-name>/<dataset-version>/``,
using the same sub-folder structure
as the media file has inside its dataset.
If :attr:`audbcards.Datacard.sphinx_build_dir`
is not ``None``,
the media sub-folder structure
is also copied
to the sphinx build dir under
``<sphinx-build-dir>/<repository-name>/<dataset-name>/``.
If :attr:`audbcards.Datacard.sphinx_src_dir` is not ``None``,
an plot of the waveform of the media file
is cached at
``${cache_root}/{name}-{version}-player-waveform.png``.
is cached under
``<dataset-name>-<dataset-version>-player-waveform.png``
inside
``<cache-root>/<dataset-name>/<dataset-version>/``.
It is also copied to the sphinx source folder into
``<sphinx-src-dir>/<repository-name>/<dataset-name>/``.
Returns:
String containing RST code to include the player
Expand Down

0 comments on commit 2730078

Please sign in to comment.