search

mapbox / mapbox-annotation-extension

Framework extensions that can be used with the Mapbox Maps SDK for iOS.
ISC License
11 stars 18 forks source link

Add API documentation #29

Closed captainbarbosa closed 4 years ago

captainbarbosa commented 5 years ago

Fills out the rest of the API documentation.

captainbarbosa commented 5 years ago

All of the MGLStyleAnnotations are documented as of https://github.com/mapbox/map-extensions-ios/pull/29/commits/547637045c4cb681760eeb53109577d9999ed482, so if you could review that @friedbunny that would be helpful :)

In the meantime I'm going to continue to document the rest of the MGLAnnotationControllers.

captainbarbosa commented 5 years ago

In general I have concerns about maintainability: links to the style spec and example code both seem mildly difficult to maintain.

Yeah, me too. But there are some specific instances where I altered the language to make documentation from the style spec and the Maps SDK better align with classes in this project.

Style spec links are likely sprinkled throughout many Mapbox products, so I would hope that the appropriate redirects and headway would be given by the docs team if that happens. Plus, I hope we wouldn't have to be in this state for too long, because we eventually want to fold all of this into the main Maps SDK.

Can they be generated and/or checked automatically?

Sure, but I don't think that is a tasks that should block getting the first few alphas/betas out the door 😃

I addressed your feedback in https://github.com/mapbox/map-extensions-ios/pull/29/commits/cd7c6679f74ee2643f52406c83aa26667cb54b9b, and finished the rest of the documentation in subsequent commits. Mind having another look? I'll squash these all together after this is approved.

captainbarbosa commented 5 years ago

I also went ahead and fixed the Jazzy configs that got borked between https://github.com/mapbox/map-extensions-ios/pull/2 and now.

captainbarbosa commented 5 years ago

I would like to introduce Jazzy template improvements introduced by https://github.com/realm/jazzy/pull/1077 by merging https://github.com/mapbox/jazzy-theme/pull/9 before this PR merges.

captainbarbosa commented 4 years ago

mapbox/jazzy-theme#9 merged so we can move forward on this.