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.

Sign up for GitHub

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

[docsprint] Clarify meaning of Map#isSourceLoaded #9589

Merged
merged 2 commits into from
Apr 20, 2020
Merged

[docsprint] Clarify meaning of Map#isSourceLoaded #9589

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3de61a
Clarify meaning of Map#isSourceLoaded
adrianababakanian Apr 17, 2020
aa77873
Rephrase to format as `true` rather than "True"
adrianababakanian Apr 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/ui/map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1393,7 +1393,8 @@ class Map extends Camera {
}

/**
* Returns a Boolean indicating whether the source is loaded.
* Returns a Boolean indicating whether the source is loaded. True if the source with
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we format that True as true?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There appears to be a bit of inconsistency in the API reference -- sometimes boolean values are formatted as true and other times as "true". I prefer the true format as well, but went with "True" due to capitalization.

I am open to changing it/hearing with others think!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should standardize on true as it's a value within Javascript. In this particular case, we can sidestep the capitalization worries by rewording slightly. How about something like "Returns true if the source is loaded, otherwise false"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense @ryanhamley -- I made a small update. It's slightly wordier than your suggestion so as to still address the initial feedback motivating this PR (i.e. what does it mean for a source to be loaded). This means there are now two sentences starting with "Returns...", but the clarity might be worth the slight redundancy here.

* the given ID in the map's style has no outstanding network requests.
*
* @param {string} id The ID of the source to be checked.
* @returns {boolean} A Boolean indicating whether the source is loaded.
Expand Down