◐ Shell
clean mode source ↗

Docs: `utilities.image_to_url()` `'image'` and related docstrings by elliot-100 · Pull Request #2106 · python-visualization/folium

elliot-100

@elliot-100

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 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

@Conengmo Conengmo linked an issue

Mar 15, 2025

that may be closed by this pull request

@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

Conengmo

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.