Skip to content

Fix doc rendering of child dataclasses #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2025
Merged

Fix doc rendering of child dataclasses #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f8fb55
Fix doc rendering of child dataclasses
NicolasHug Mar 24, 2025
0988e99
Fix
NicolasHug Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/_templates/dataclass.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@
.. autoclass:: {{ name }}
:members:
:undoc-members: __init__
:inherited-members:
1 change: 0 additions & 1 deletion examples/audio_decoding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ def play_audio(samples):
# all streams start exactly at 0! This is not a bug in TorchCodec, this is a
# property of the file that was defined when it was encoded.
#
# %%
# Specifying a range
# ------------------
#
Expand Down
7 changes: 1 addition & 6 deletions src/torchcodec/decoders/_core/_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,6 @@
SPACES = " "


# TODO-AUDIO: docs below are mostly for video streams, we should edit them and /
# or make sure they're OK for audio streams as well. Not sure how to best handle
# docs for such class hierarchy.
# TODO very related, none of these common fields in this base class show up in
# the docs right now.
@dataclass
class StreamMetadata:
duration_seconds_from_header: Optional[float]
Expand All @@ -40,7 +35,7 @@ class StreamMetadata:
codec: Optional[str]
"""Codec (str or None)."""
stream_index: int
"""Index of the stream within the video (int)."""
"""Index of the stream that this metadata refers to (int)."""

def __repr__(self):
s = self.__class__.__name__ + ":\n"
Expand Down
Loading