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

Predicate documentation should go into more detail #6407

Closed
1ec5 opened this issue Sep 21, 2016 · 0 comments · Fixed by #6588
Closed

Predicate documentation should go into more detail #6407

1ec5 opened this issue Sep 21, 2016 · 0 comments · Fixed by #6588
Assignees
Labels
clustering documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling
Milestone

Comments

@1ec5
Copy link
Contributor

1ec5 commented Sep 21, 2016

The documentation comment for four MGLStyleLayer subclass’s predicate property doesn’t go into too much detail, relying instead on a link to the style specification’s Filter documentation to provide more details. But the Filter documentation is expressed in a syntax completely foreign to iOS/macOS developers, who must create an NSPredicate instead of a nested array of strings. Though Apple’s NSPredicate documentation is thorough when it comes to expressable operators, there are a lot of expressable operators that implementations can choose not to implement, and indeed we haven’t implemented operators such as LIKE, BEGINSWITH, and blocks. Moreover, the style specification and Supercluster reserve the following keys:

All these nuances would cause the predicate property documentation to grow unwieldy. To make matters worse, the property is declared redundantly on four individual MGLStyleLayer subclass. We should consolidate them into a single property: #6406. Beyond that, we could add our first appendix on the subject (realm/jazzy#435), giving predicates a little more discoverability.

/cc @friedbunny @frederoni

@1ec5 1ec5 added iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS documentation runtime styling clustering labels Sep 21, 2016
@1ec5 1ec5 added this to the ios-v3.4.0 milestone Sep 21, 2016
@1ec5 1ec5 self-assigned this Oct 5, 2016
@1ec5 1ec5 closed this as completed in #6588 Oct 6, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
clustering 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.

1 participant