Document the public 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.
github-actions
Bot
added
p: vector_math
triage-framework
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
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. |
2 participants
Description
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.
Related Issues
Fixes part of flutter/flutter#186827
Tests
dart analyze— no issues founddart test— all 252 tests passDocs-only change; no behavior modified.