Use string values for ol.source.State enum #2247
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
+1 |
|
Looks good to me. |
| * State of the source. `0` means 'loading', `1` means 'ready', and `2` means | ||
| * 'error'. | ||
| * @enum {number} | ||
| * State of the source. |
There was a problem hiding this comment.
For the API docs to list the states, you need to mention them in prose. Something like "State of the source. Can be loading, ready or error.".
Many user-facing enums are string values and we document use of the string values rather than more confusing enum reference or the numeric values.
|
Thanks for the comments, documentation updated. |
pagameba
added a commit
that referenced
this pull request
Jun 26, 2014
Use string values for ol.source.State enum
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many user-facing enums are string values and we document use of the string values rather than more confusing enum reference or the numeric values.