maplibre-style-spec icon indicating copy to clipboard operation
maplibre-style-spec copied to clipboard

Clarify parameters for interpolate expression

Open ward opened this issue 1 year ago • 2 comments

The parameters to the interpolate expression were unclear to me. Instead, this PR adds names for the parameters in the syntax example. It also specifies all allowed types of stop_output_i, based on the text preceding it.

Launch Checklist

  • [ ] Confirm your changes do not include backports from Mapbox projects (unless with compliant license) - if you are not sure about this, please ask! I saw the parameter names after being told to compare current docs with mapbox docs for interpolate. Does that count as backport?
  • [x] Briefly describe the changes in this PR.
  • [ ] Add an entry to CHANGELOG.md under the ## main section. --> I don't know if this change is significant enough for that.
  • [ ] The syntax method is turning into a pretty long line in the docs this way. Is there a way to tell it to spread across multiple lines or does that involve editing the code that actually generates the docs?

ward avatar Sep 25 '24 17:09 ward

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.70%. Comparing base (947b273) to head (e300747). Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #833   +/-   ##
=======================================
  Coverage   92.70%   92.70%           
=======================================
  Files         105      105           
  Lines        4646     4646           
  Branches     1312     1312           
=======================================
  Hits         4307     4307           
  Misses        339      339           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Sep 25 '24 17:09 codecov-commenter

Thanks for taking the time to open this PR! Most syntax definitions do not have a parameter name and type, most only have type. I find this syntax definition not so helpful in most cases, do you think more examples or improving the text of this item can be a better solution? Also it would be great if you could attach a before and after screenshots of the docs in regards to this change.

THANKS!!

HarelM avatar Sep 25 '24 18:09 HarelM

Any updates on this?

HarelM avatar Oct 16 '24 11:10 HarelM

@ward can you address the comment I made?

HarelM avatar Oct 22 '24 12:10 HarelM

Closing at there was not response. If there is still an issue, feel free to open a new PR or reopen this one.

HarelM avatar Oct 31 '24 13:10 HarelM