Skip to content

docs: update ImageOverlay with local file example #2111

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

Merged
merged 1 commit into from
Mar 16, 2025

Conversation

Conengmo
Copy link
Member

@Conengmo Conengmo commented Mar 15, 2025

Closes #2094

Update the ImageOverlay example in the docs that shows how to use a local file. The previous example file is no longer included after the docs overhaul. This example breaking was not spotted because the code there is robust to the file not existing.

  • Use another image that exists in the docs static files: the Folium logo. Easy and for the example it doesn't really matter I think.
  • Make it raise an error if the file not exists. That way we will be notified if this example breaks in the future.

Screenshot

Capture

@hansthen hansthen merged commit 661fc9f into python-visualization:main Mar 16, 2025
11 checks passed
@Conengmo Conengmo deleted the docs-image-url branch March 16, 2025 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

User guide ImageOverlay example is missing the image file
2 participants