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

Runtime styling enumerations are undocumented #5953

Closed
1ec5 opened this issue Aug 11, 2016 · 3 comments
Closed

Runtime styling enumerations are undocumented #5953

1ec5 opened this issue Aug 11, 2016 · 3 comments
Labels
bug documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS release blocker Blocks the next final release runtime styling
Milestone

Comments

@1ec5
Copy link
Contributor

1ec5 commented Aug 11, 2016

Per #5727 (comment), all the runtime styling enumerations are undocumented. We need to come up with documentation comments for each enumeration typedef as well as each individual enumeration value. I think it’ll be fine to let these enumerations fall into the default enumeration bucket in the jazzy table of contents.

For starters, we could generate the comments by parsing the documentation for the attributes that use the enumerations. But we should eventually have a mechanism for specifying overrides of style specification documentation where we can manually draft these comments.

/cc @frederoni @friedbunny

@1ec5
Copy link
Contributor Author

1ec5 commented Sep 19, 2016

Blocked by mapbox/mapbox-gl-style-spec#497. Given that proposal, I don’t think we should bother doing any fancy parsing of English text to come up with enum documentation, as I proposed above.

@incanus
Copy link
Contributor

incanus commented Sep 30, 2016

@1ec5 Can we close this here then since #6508 landed?

@1ec5
Copy link
Contributor Author

1ec5 commented Sep 30, 2016

Yes, and #6107 will implement an override mechanism for remaining edge cases. Thanks for taking care of that!

@1ec5 1ec5 closed this as completed Sep 30, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS release blocker Blocks the next final release runtime styling
Projects
None yet
Development

No branches or pull requests

2 participants