Document version property #2871
Conversation
| * Gets the version number of Mapbox GL JS. | ||
| * | ||
| * @var version | ||
| */ |
There was a problem hiding this comment.
Can we declare that version is a string?
There was a problem hiding this comment.
Can we provide any additional context here for users who don't immediately make the leap from version number to git tags, npm, GitHub releases, etc
There was a problem hiding this comment.
I do not know of a way to declare that a var is a string. If I add a type, e.g. @var version {string}, compilation for that item seems to fail. Do you know of another way this should be marked with JSDoc?
Regarding context, what do you think of this? To learn more about the differences between published versions of Mapbox GL JS, have a look at [the changelog](https://github.com/mapbox/mapbox-gl-js/blob/master/CHANGELOG.md). Sufficient? I guess I'm not sure what else to say here ... open to ideas.
|
Looks like I've pushed a few commits. 🚢 if this looks good to you! |
|
Thanks, @lucaswoj, and sorry for my obtuseness --- I just put the type in the wrong place (；一_一). What you've done makes sense. |
* Document version property * Specify the types for mapboxgl properties * Improve docs for `mapboxgl#version` * Move mapboxgl docs to mapbox-gl.js
Ref #2851 (comment)