Skip to content

Commit 9aa5af9

Browse files
committed
Fix doc warnings
1 parent 8cd8926 commit 9aa5af9

3 files changed

Lines changed: 12 additions & 13 deletions

File tree

av/packet.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ def has_sidedata(self, dtype: str) -> bool:
446446
def get_sidedata(self, dtype: str) -> PacketSideData:
447447
"""get a copy of the side data
448448
449-
:param dtype: side data type (:method:`~av.packet.PacketSideData.sidedata_types` for the full list of options)
449+
:param dtype: side data type (:meth:`~av.packet.PacketSideData.sidedata_types` for the full list of options)
450450
:type dtype: str
451451
:return: newly created copy of the side data if the side data of the
452452
requested type is found in the packet, else an empty object

av/subtitles/subtitle.py

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,18 @@ def create(
4747
"""
4848
Create a SubtitleSet for encoding.
4949
50-
Args:
51-
text: The subtitle text in ASS dialogue format
52-
(e.g. b"0,0,Default,,0,0,0,,Hello World")
53-
start: Start display time as offset from pts (typically 0)
54-
end: End display time as offset from pts (i.e., duration)
55-
pts: Presentation timestamp in stream time_base units
56-
subtitle_format: Subtitle format (default 1 for text)
57-
58-
Note:
50+
:param text: The subtitle text in ASS dialogue format
51+
(e.g. ``b"0,0,Default,,0,0,0,,Hello World"``)
52+
:param start: Start display time as offset from pts (typically 0)
53+
:param end: End display time as offset from pts (i.e., duration)
54+
:param pts: Presentation timestamp in stream time_base units
55+
:param subtitle_format: Subtitle format (default 1 for text)
56+
:return: A SubtitleSet ready for encoding
57+
58+
.. note::
5959
All timing values should be in stream time_base units.
6060
For MKV (time_base=1/1000), units are milliseconds.
6161
For MP4 (time_base=1/1000000), units are microseconds.
62-
63-
Returns:
64-
A SubtitleSet ready for encoding
6562
"""
6663
subset: SubtitleSet = SubtitleSet(_cinit_bypass_sentinel)
6764

docs/overview/installation.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Bring your own FFmpeg
2727
PyAV can also be compiled against your own build of FFmpeg (version ``8.0`` or higher). You can force installing PyAV from source by running:
2828

2929
.. code-block:: bash
30+
3031
pip install av --no-binary av
32+
3133
PyAV depends upon several libraries from FFmpeg:
3234

3335
- ``libavcodec``

0 commit comments

Comments
 (0)