options.popup defaults to "false", but documented as "true"

slaymance commented 2 years ago

The options.popup parameter to MaplibreGeocoder is defaulted to false while the JSDoc definition and reference in API.md specify the default value of options.popup as true.

We can resolve this by either:

Setting the default value of options.popup to true (L87)
Updating the JSDoc description (L47) and the reference in API.md (L99) to a default value of false

Updating reference to the default value has the benefit of not impacting users' applications if they upgrade to the version which contains the fix.

HarelM commented 4 weeks ago

I think updating the docs is the right approach at this point, feel free to submit a PR.

HarelM commented 3 weeks ago

Should be fixed by #118 You can check out the new docs at https://www.maplibre.org/maplibre-gl-geocoder/

maplibre / maplibre-gl-geocoder

options.popup defaults to "false", but documented as "true" #21