[vector_math] Document CircleGenerator API - #37
Conversation
Removes the public_member_api_docs ignore for circle_generator.dart and documents the class and its public createCircle constructor method, per the ongoing vector_math doc migration tracked in flutter/flutter#186827.
There was a problem hiding this comment.
Code Review
This pull request documents the public CircleGenerator API in the vector_math package. It removes the ignore rule for public member API documentation in circle_generator.dart, adds documentation comments to the CircleGenerator class and its createCircle method, and updates the package version to 2.4.3 in pubspec.yaml and CHANGELOG.md. There are no review comments, and I have no feedback to provide.
|
Thank you for your contribution! Because of the volume of PRs we receive, we require that new contributors use our checklist to guide them through critical steps in creating a Flutter PR. This PR's description is missing that checklist, so it is being marked as a Draft. Please edit the PR description to add the checklist, then ensure that you have completed all of the steps. Once you've done that, please mark the PR as ready for review. If you need help, consider asking for advice on the #hackers-new channel on Discord. |
There was a problem hiding this comment.
Code Review
This pull request updates the vector_math package to version 2.4.3 by documenting the public CircleGenerator API. Specifically, it removes the ignore_for_file directive for public member API documentation in circle_generator.dart and adds documentation comments to the CircleGenerator class and the createCircle method. The CHANGELOG.md and pubspec.yaml files are updated to reflect the version bump. There are no review comments, so there is no additional feedback to provide.
|
@stuartmorgan-g kindly review it. |
|
Please don't ping individual people to request reviews. This PR will be assigned to one of the package owners for review during our regular triage, as with any other PR. |
Adds public API docs for
CircleGenerator(class andcreateCircle) and removes thepublic_member_api_docsignore forcircle_generator.dart, following the same pattern as #12 and #22.Part of the ongoing vector_math doc migration tracked in flutter/flutter#186827.
Validation
dart analyzedart test(252 tests)dart pub global run flutter_plugin_tools validate --packages=vector_mathdart pub global run flutter_plugin_tools format --packages=vector_math --fail-on-change --no-swiftdart pub global run flutter_plugin_tools publish-check --packages=vector_math --allow-pre-releasePre-Review Checklist
[shared_preferences]///).No new tests were added because the implementation diff only changes documentation comments. The complete existing package test suite passes.
If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2