Skip to content

Commit 8836f52

Browse files
committed
docs: keep Exporter class docs detailed for better UX
1 parent d659fb4 commit 8836f52

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

ytfetcher/services/exports.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@ class Exporter:
1616
"""
1717
DEPRECATED: Use TXTExporter, JSONExporter, or CSVExporter instead.\n
1818
This class is kept for backward compatibility and will be removed in a future versions.
19+
20+
Parameters:
21+
channel_data (list[ChannelData]): The transcript and metadata to export.
22+
allowed_metadata_list (list): Metadata fields to include (e.g., ['title', 'description']).
23+
timing (bool): Whether to include start/duration timing in exports.
24+
filename (str): Output filename without extension.
25+
output_dir (str | None): Directory to export files into. Defaults to current working directory.
26+
27+
Raises:
28+
NoDataToExport: If no data is provided.
29+
OutputDirectoryNotFoundError: If specified path cannot found.
1930
"""
2031
def __init__(self, *args, **kwargs):
2132
warnings.warn(

0 commit comments

Comments
 (0)