Skip to content

Update image_video_overlay.rst #664

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

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/source/api_reference/image_video_overlay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Attributes
=========== ======================== ===
Attribute Default Value Doc
=========== ======================== ===
url "" An http url to the footage or a relative path to a local file (image/video). Note that absolute local paths are not supported.
url "" An http url to the footage or a relative path to a local file (image/video). Note that absolute local paths are not supported (e.g. ‘image.png’ or ‘files/working_dir/image.png’ in JupyterLab).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand, this makes it not clear if image.png and files/working_dir/image.png are supported or not, and in JupyterLab or not.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are 2 spaces in: "supported ("

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok thanks for the comment I just made another PR to improve this let me know if it is ok.
New text:

An http url to the footage or a relative path to a local file (image/video, e.g. ‘image.png’ or ‘files/working_dir/image.png’ in JupyterLab). Note that absolute local paths are not supported.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok let's close this one then.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You didn't have to open a new PR, you could push new commits to this one.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok sorry, just noticed it.
Thanks

bounds ((0.0, 0.0), (0.0, 0.0)) SW and NE corners of the image
=========== ======================== ===