Docs: Improve in expression example
#664
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #664 +/- ##
=======================================
Coverage 92.45% 92.45%
=======================================
Files 104 104
Lines 4624 4624
Branches 1303 1303
=======================================
Hits 4275 4275
Misses 349 349 ☔ View full report in Codecov by Sentry. |
HarelM
reviewed
May 15, 2024
| @@ -2791,7 +2791,7 @@ | |||
| "doc": "Determines whether an item exists in an array or a substring exists in a string.\n\n - [Measure distances](https://maplibre.org/maplibre-gl-js/docs/examples/measure/)", | |||
| "example": { | |||
| "syntax": { | |||
| "method": ["value", "value"], | |||
| "method": [["get", "value"], ["literal", "value"]], | |||
There was a problem hiding this comment.
This is the syntax part of the example, so this won't be the right place to put it.
You can use links to places in the description, for example add a page in the gl js examples with all forms of "in".
You can link to tests in this repo too.
Or your could extend the code that parses the v8 into docs to have multiple examples for expressions.
|
Closed for now, follow up todos in #664 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The goal is to improve https://maplibre.org/maplibre-style-spec/expressions/#in to better explain the two way
incan be used.["in", ["get", "firstName"], "Hans Müller"]which would be true forfirstName: "Hans"(at least that is how I understand the spec)["in", ["get", "firstName"], ["literal", ["Hans", "Dieter", "Rudolf"]]]which would be true forfirstName: "Hans"See also #555 (comment)
This change does not reflect this goal, but I think it's the best we can do which how the v8.json file is structured ATM. It does not look like it allows for multiple examples or for the examples to have variations.