Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Split out guide about predicates #9948

Closed
1ec5 opened this issue Sep 10, 2017 · 0 comments · Fixed by #10726
Closed

Split out guide about predicates #9948

1ec5 opened this issue Sep 10, 2017 · 0 comments · Fixed by #10726
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling

Comments

@1ec5
Copy link
Contributor

1ec5 commented Sep 10, 2017

MGLVectorStyleLayer.predicate has documentation with enough detail that it could stand on its own as a jazzy guide, similar to the one for tile URL templates. We already use predicates in multiple parts of the API, including the feature querying methods of MGLMapView and MGLVectorSource, so centralizing the documentation in a guide would make it easier to see all those APIs as being related. Once we replace MGLStyleValue with NSExpression (#8074), it’ll be all the more important to document expressions and predicates in one place.

This documentation doesn’t differ at all between iOS and macOS, so all we need is a Markdown document in platform/darwin/docs/guides/. However, we’ll also need a small amount of code generation if we introduce any code examples into that guide.

The new guide should link to this section of the “Information for Style Authors” guide that discusses predicates. I think that section can stay where it is, because folks who only work with the runtime styling API won’t need to see it.

/cc @captainbarbosa @jmkiley @anandthakker

@1ec5 1ec5 added documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling labels Sep 10, 2017
@1ec5 1ec5 added this to the ios-v3.7.0 milestone Sep 10, 2017
@boundsj boundsj removed this from the ios-v3.7.0 milestone Sep 18, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants