Skip to content

Docs: utilities.image_to_url() 'image' and related docstrings #2106

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

Conversation

elliot-100
Copy link
Contributor

@elliot-100 elliot-100 commented Mar 11, 2025

Fixes #2905.

  • Amends docstring for utilities.image_to_url() 'image' parameter (not part of publicly documented API)
  • Adapts this amend for these members of publicly documented API, depending on context:
    • features.CustomIcon 'icon_image' parameter/attributes
    • raster_layers.ImageOverlay 'image' parameter/attributes
  • Uses more consistent indenting

@elliot-100 elliot-100 force-pushed the docs-fix-#2905-utilities.image_to_url() branch from 827f01f to a63ed13 Compare March 11, 2025 11:24
@elliot-100 elliot-100 changed the title Docs: Fix #2905 utilities.image_to_url() image parameter docstring Docs: Fix #2905 utilities.image_to_url() 'image' and related docstrings Mar 11, 2025
@elliot-100 elliot-100 marked this pull request as ready for review March 11, 2025 12:20
@Conengmo Conengmo changed the title Docs: Fix #2905 utilities.image_to_url() 'image' and related docstrings Docs: utilities.image_to_url() 'image' and related docstrings Mar 15, 2025
Copy link
Member

@Conengmo Conengmo left a comment

Choose a reason for hiding this comment

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

Thanks @elliot-100, great that these docs are now better in line with the actual functionality. I was building docs locally anyway so I made sure the lists turn out alright in the API reference in the docs: turns out you need an empty line before the list. Also made sure the number of spaces between the * and the text is one.

@Conengmo Conengmo merged commit d1b1460 into python-visualization:main Mar 15, 2025
11 checks passed
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.

utilities.image_to_url() image parameter has multiple documentation issues
2 participants