Skip to content
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.

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

Fill gaps in image encoding documentation, fix how python documents union variants #4988

Merged
merged 12 commits into from
Feb 1, 2024
Prev Previous commit
Next Next commit
fix mkdocs warnings
  • Loading branch information
Wumpf committed Feb 1, 2024
commit fe9ea72e775f576591f5635f69802272fc06ee7f
13 changes: 4 additions & 9 deletions rerun_py/rerun_sdk/rerun/_image.py
Original file line number Diff line number Diff line change
@@ -49,10 +49,8 @@ class ImageFormat:
"""
Raw NV12 encoded image.

Parameters
----------
size_hint:
A tuple of (height, width), specifying the RGB size of the image
The type comes with a `size_hint` attribute, a tuple of (height, width)
which has to be specified specifying in order to set the RGB size of the image.
"""

YUY2: type[YUY2]
@@ -61,11 +59,8 @@ class ImageFormat:

YUY2 is a YUV422 encoding with bytes ordered as `yuyv`.


Parameters
----------
size_hint:
A tuple of (height, width), specifying the RGB size of the image
The type comes with a `size_hint` attribute, a tuple of (height, width)
which has to be specified specifying in order to set the RGB size of the image.
"""

def __init__(self, name: str):
Loading