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

[viewport] Refinements to public API documentation. #1142

Merged
merged 2 commits into from
Feb 10, 2022

Conversation

pengdev
Copy link
Member

@pengdev pengdev commented Feb 10, 2022

Summary of changes

This PR refines the public API documentation for viewport plugin, and align with iOS API docs.

User impact (optional)

Pull request checklist:

  • Briefly describe the changes in this PR.
  • Include before/after visuals or gifs if this PR includes visual changes.
  • Write tests for all new functionality. If tests were not written, please explain why.
  • Optimize code for java consumption (@JvmOverloads, @file:JvmName, etc).
  • Add example if relevant.
  • Document any changes to public APIs.
  • Apply changelog label ('breaking change', 'bug 🪲', 'build', 'docs', 'feature 🍏', 'performance ⚡', 'testing 💯') or use the label 'skip changelog'
  • Add an entry inside this element for inclusion in the mapbox-maps-android changelog: <changelog></changelog>.
  • If this PR is a v10.[version] release branch fix / enhancement, merge it to main firstly and then port to v10.[version] release branch.

Fixes: < Link to related issues that will be fixed by this pull request, if they exist >

PRs must be submitted under the terms of our Contributor License Agreement CLA.

Copy link
Contributor

@kiryldz kiryldz left a comment

Choose a reason for hiding this comment

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

LGTM with nits

@pengdev pengdev merged commit 1b6d31d into main Feb 10, 2022
@pengdev pengdev deleted the peng-improve-viewport-apidoc branch February 10, 2022 15:35
pengdev added a commit that referenced this pull request Feb 10, 2022
* [viewport] Refinements to public API documentation.

* Address review comments.
pengdev added a commit that referenced this pull request Feb 10, 2022
* [viewport] Refinements to public API documentation.

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

Successfully merging this pull request may close these issues.

3 participants