Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Make it easier to find styling options for features #857

Closed
wphicks opened this issue Jun 27, 2018 · 2 comments · Fixed by #904
Closed

Documentation: Make it easier to find styling options for features #857

wphicks opened this issue Jun 27, 2018 · 2 comments · Fixed by #904

Comments

@wphicks
Copy link
Contributor

wphicks commented Jun 27, 2018

It would be helpful to make it easier to find available styling options for features. As a specific example, if I look at the documentation for polygonFeature, I don't see what style options are available for polygons.

@manthey
Copy link
Contributor

manthey commented Jun 27, 2018

Some of this was improved in PR #819, so at least the styles are enumerated in the geo.polygonFeature.spec, though this hasn't been published to github.io yet.

For polygons (and features that subclass the style function), we could put a link to the appropriate typedef (or, less optimally, duplicate the docs from that typedef). For features where the style function is inherited, this wouldn't be directly possible.

@wphicks, do you think a link to the appropriate typedef is sufficient, or do you think that duplicating the documentation would be preferred?

@wphicks
Copy link
Contributor Author

wphicks commented Jun 27, 2018

I think a link to the appropriate typedef would be perfect. So long as someone who starts by searching for "style" knows where to go, that should work fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants