Improve docs by adding missing functions#4198
Open
benoit-ctrl wants to merge 1 commit intornmapbox:mainfrom
Open
Improve docs by adding missing functions#4198benoit-ctrl wants to merge 1 commit intornmapbox:mainfrom
benoit-ctrl wants to merge 1 commit intornmapbox:mainfrom
Conversation
benoit-ctrl
had a problem deploying
to
CI with Mapbox Tokens
GitHub Actions
Error
benoit-ctrl
had a problem deploying
to
CI with Mapbox Tokens
GitHub Actions
Error
benoit-ctrl
had a problem deploying
to
CI with Mapbox Tokens
GitHub Actions
Error
benoit-ctrl
force-pushed
the
docs/improve-docs
branch
from
acae6d1 to
9f45184
Compare
benoit-ctrl
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
While reviewing the docs I noticed that several public functions and types were missing JSDoc, so a number of docs/*.md pages were either empty or only listed prop names without any explanation. I went through the affected source files (locationManager, Camera, Viewport, UserLocation, LocationPuck, CustomLocationProvider, etc.), added the missing JSDoc, fixed a few typos along the way, and regenerated the markdown docs with yarn generate.
No runtime behavior is changed — this is documentation only.
Checklist
CONTRIBUTING.mdyarn generatein the root folder/exampleapp./example)