Update image_video_overlay.rst #665
Conversation
| @@ -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, e.g. ‘image.png’ or ‘files/working_dir/image.png’ in JupyterLab). Note that absolute local paths are not supported. | |||
There was a problem hiding this comment.
What is different in JupyterLab, the files/ prefix?
There was a problem hiding this comment.
Yes, otherwise it does not work.
There was a problem hiding this comment.
Maybe we should make it clearer, like: "Note that in JupyterLab the path must be prefixed with files/, e.g. files/image.png".
There was a problem hiding this comment.
Also important is the current working folder name so you have to add "files/my_working_dir/", this is a bit strange and it is not mentioned anywhere.
There was a problem hiding this comment.
It is mentioned there in the documentation: https://ipyleaflet.readthedocs.io/en/latest/api_reference/local_tile_layer.html#example
There was a problem hiding this comment.
In Jupyter Notebook the path is relative to the Notebook. In JupyterLab it's relative to the server.
There was a problem hiding this comment.
Also important is the current working folder name so you have to add "files/my_working_dir/", this is a bit strange and it is not mentioned anywhere.
Yes but this is not specific to JupyterLab, so we should make it consistent with the notebook.
There was a problem hiding this comment.
In Jupyter Notebook the path is relative to the Notebook. In JupyterLab it's relative to the server.
Thanks, then this should also be mentioned.
|
The CI error is very odd. Definitely not related to the changes here though. |
Improve documentation for image_video_overlay