Skip to content

[vector_math] Document CircleGenerator API - #37

Open
faisalansari0367 wants to merge 1 commit into
flutter:mainfrom
faisalansari0367:docs/vector-math-circle-generator
Open

[vector_math] Document CircleGenerator API#37
faisalansari0367 wants to merge 1 commit into
flutter:mainfrom
faisalansari0367:docs/vector-math-circle-generator

Conversation

@faisalansari0367

@faisalansari0367 faisalansari0367 commented Aug 27, 2026

Copy link
Copy Markdown

Adds public API docs for CircleGenerator (class and createCircle) and removes the public_member_api_docs ignore for circle_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 analyze
  • dart test (252 tests)
  • dart pub global run flutter_plugin_tools validate --packages=vector_math
  • dart pub global run flutter_plugin_tools format --packages=vector_math --fail-on-change --no-swift
  • dart pub global run flutter_plugin_tools publish-check --packages=vector_math --allow-pre-release

Pre-Review Checklist

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-assist bot 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

  1. 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

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 github-actions Bot added p: vector_math triage-framework Should be looked at in framework triage labels Aug 27, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

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.

@stuartmorgan-g
stuartmorgan-g marked this pull request as draft September 1, 2026 20:23
@faisalansari0367 faisalansari0367 changed the title Document the public CircleGenerator API [vector_math] Document CircleGenerator API Sep 5, 2026
@faisalansari0367
faisalansari0367 marked this pull request as ready for review September 5, 2026 10:41

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

@faisalansari0367

Copy link
Copy Markdown
Author

@stuartmorgan-g kindly review it.

@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

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.

@Piinks
Piinks requested review from dkwingsmt and elliette September 8, 2026 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

p: vector_math triage-framework Should be looked at in framework triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants