Document vector_math Plane API - #12
stuartmorgan-g merged 3 commits into
Conversation
github-actions
Bot
added
p: vector_math
triage-framework
|
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 |
6c05e06 to
94b673b
Compare
This comment was marked as off-topic.
This comment was marked as off-topic.
|
It looks like this PR is failing the dart format presubmit check. |
|
Please see #22 (comment); this needs to use our contribution checklist. |
|
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. |
|
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. |
4e50306 to
0078c4e
Compare
Piinks
left a comment
Piinks
left a comment
There was a problem hiding this comment.
Oh I forgot, this needs an update to the changelog and pubspec so we can publish as a new release. :)
|
Addressed, thanks! I bumped I also ran the package validation, formatter check, analyzer, |
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 - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [x] I read the [Tree Hygiene] page, which explains my responsibilities. - [x] I read and followed the [relevant style guides] and ran [the auto-formatter]. - [x] I signed the [CLA]. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [x] I [linked to at least one issue that this PR fixes] in the description above. - [x] I followed [the version and CHANGELOG instructions], using [semantic versioning] and the [repository CHANGELOG style], or I have commented below to indicate which documented exception this PR falls under[^1]. - [x] I updated/added any relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or I have commented below to indicate which [test exemption] this PR falls under[^1]. - [x] All existing and new tests are passing. 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](https://developers.google.com/gemini-code-assist/docs/review-github-code). 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. [^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. <!-- Links --> [Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md [relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style [the auto-formatter]: https://github.com/flutter/packages/blob/main/script/tool/README.md#format-code [CLA]: https://cla.developers.google.com/ [Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md [linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#overview [the version and CHANGELOG instructions]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#version-and-changelog-updates [semantic versioning]: https://dart.dev/tools/pub/versioning#semantic-versions [repository CHANGELOG style]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog-style [test exemption]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#tests --------- Co-authored-by: Tong Mu <dkwingsmt@users.noreply.github.com>
5 participants
Summary
PlaneAPI invector_mathandvector_math_64.public_member_api_docsignore for bothPlaneimplementations.CHANGELOG.mdentry for the docs update.Part of flutter/flutter#186827.
Validation
dart analyzedart test test/plane_test.dartdart pub global run flutter_plugin_tools analyze --packages=vector_mathdart pub global run flutter_plugin_tools test --packages=vector_mathdart pub global run flutter_plugin_tools format --packages=vector_math --fail-on-change --no-swift