Skip to content

Document vector_math Plane API#12

Merged
stuartmorgan-g merged 3 commits into
flutter:mainfrom
faheemabbas766:codex/document-vector-math-plane
Jul 22, 2026
Merged

Document vector_math Plane API#12
stuartmorgan-g merged 3 commits into
flutter:mainfrom
faheemabbas766:codex/document-vector-math-plane

Conversation

@faheemabbas766

@faheemabbas766 faheemabbas766 commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Documents the public Plane API in vector_math and vector_math_64.
  • Removes the file-level public_member_api_docs ignore for both Plane implementations.
  • Adds a CHANGELOG.md entry for the docs update.

Part of flutter/flutter#186827.

Validation

  • dart analyze
  • dart test test/plane_test.dart
  • dart pub global run flutter_plugin_tools analyze --packages=vector_math
  • dart pub global run flutter_plugin_tools test --packages=vector_math
  • dart pub global run flutter_plugin_tools format --packages=vector_math --fail-on-change --no-swift

@github-actions github-actions Bot added p: vector_math triage-framework Should be looked at in framework triage labels Jun 2, 2026
@faheemabbas766
faheemabbas766 marked this pull request as ready for review June 2, 2026 05:43
@Piinks
Piinks self-requested a review June 2, 2026 22:13
@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

I've updated the PR description to reflect that the fact that this PR only address two out of 24 references to that issue.

In the future, please don't indicate that a PR will close an issue if it only partially addresses on, as GitHub will auto-close the issue on PR submit with specific keywords that indicate that it's a fix.

@faheemabbas766

Copy link
Copy Markdown
Contributor Author

I've updated the PR description to reflect that the fact that this PR only address two out of 24 references to that issue.

In the future, please don't indicate that a PR will close an issue if it only partially addresses on, as GitHub will auto-close the issue on PR submit with specific keywords that indicate that it's a fix.

Thanks for the clarification. Understood.

I’ll avoid using Fixes/Closes in future PRs when the change only partially addresses an issue, and will use wording like Part of instead.

@faheemabbas766
faheemabbas766 force-pushed the codex/document-vector-math-plane branch from 6c05e06 to 94b673b Compare June 8, 2026 04:06
@johnmccutchan

This comment was marked as off-topic.

@johnmccutchan
johnmccutchan self-requested a review June 17, 2026 16:28
@zanderso

Copy link
Copy Markdown
Member

It looks like this PR is failing the dart format presubmit check.

@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

Please see #22 (comment); this needs to use our contribution checklist.

@faheemabbas766

Copy link
Copy Markdown
Contributor Author

Thanks for the guidance. I’ve submitted the vector_math documentation changes to the source repository here: https://github.com/google/vector_math.dart/pull/373\n\nI’ll leave this mirror PR as-is for now unless you prefer that I close it.

@zanderso

Copy link
Copy Markdown
Member

Hi @faheemabbas766, sorry about the confusion and crossed wires on our side. The repo at https://github.com/google/vector_math.dart has been archived, and this repo (flutter/core-packages) is the correct target for your PR.

@Piinks
Piinks force-pushed the codex/document-vector-math-plane branch from 4e50306 to 0078c4e Compare July 20, 2026 23:46

@Piinks Piinks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Piinks
Piinks previously requested changes Jul 21, 2026

@Piinks Piinks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh I forgot, this needs an update to the changelog and pubspec so we can publish as a new release. :)

@faheemabbas766

Copy link
Copy Markdown
Contributor Author

Addressed, thanks! I bumped vector_math to 2.4.1 and added a 2.4.1 CHANGELOG entry for the public Plane API documentation.

I also ran the package validation, formatter check, analyzer, plane_test.dart, and publish check locally; all passed. The fork workflows are currently awaiting maintainer approval.

@stuartmorgan-g
stuartmorgan-g merged commit 0313a3c into flutter:main Jul 22, 2026
13 checks passed
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.

5 participants