Skip to content

[vector_math] Document SphereGenerator API - #42

Open
mahaamimran wants to merge 1 commit into
flutter:mainfrom
mahaamimran:docs-vector-math-sphere-generator
Open

mahaamimran wants to merge 1 commit into
flutter:mainfrom
mahaamimran:docs-vector-math-sphere-generator

Conversation

@mahaamimran

Copy link
Copy Markdown

Adds public API docs for SphereGenerator (the class and createSphere) and removes the public_member_api_docs ignore for sphere_generator.dart, following the same pattern as #12, #22 and #37.

Part of the ongoing vector_math doc migration tracked in flutter/flutter#186827.

Validation

  • dart analyze
  • dart test (252 tests)
  • flutter_plugin_tools validate, format --fail-on-change --no-swift and publish-check for vector_math

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

@github-actions github-actions Bot added p: vector_math triage-framework Should be looked at in framework triage labels Oct 22, 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 updates the vector_math package to version 2.4.4. It removes the public member API documentation ignore rule from sphere_generator.dart and adds documentation comments for the SphereGenerator class and its createSphere method. The CHANGELOG.md and pubspec.yaml files are updated accordingly. There are no review comments, and I have no feedback to provide.

@justinmc
justinmc self-requested a review October 27, 2026 22:41
@justinmc

Copy link
Copy Markdown
Contributor

@mahaamimran Heads up there is a conflict in the Changelog, could you fix that?

@mahaamimran
mahaamimran force-pushed the docs-vector-math-sphere-generator branch from 2dd9471 to 8f80ddb Compare October 29, 2026 16:51
@mahaamimran

Copy link
Copy Markdown
Author

Thanks @justinmc! Rebased on latest main and resolved the CHANGELOG conflict (bumped to 2.4.5, since 2.4.4 was taken by #45). Ready for another look.

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