Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Clarify Transform.rotate origin interaction with alignment #163934

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

SunkenInTime
Copy link

This commit improves the documentation for Transform.rotate's origin property to clarify its interaction with the alignment property.

Before: The documentation did not clearly explain how the origin offset interacts with the alignment property, potentially leading to confusion about the actual rotation point.

After: The documentation now emphasizes that the origin offset is applied after the alignment transformation, and provides examples to avoid common misinterpretations.

This change ensures developers can correctly position the rotation point.

This commit improves the documentation for Transform.rotate's origin property to clarify its interaction with the alignment property. It emphasizes that the origin offset is applied after the alignment transformation, and provides examples to avoid common misinterpretations.
@github-actions github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label Feb 22, 2025
@justinmc
Copy link
Contributor

@SunkenInTime Heads up that there are failures. I'll try to take a look at this later, thanks for the PR!

@SunkenInTime
Copy link
Author

SunkenInTime commented Feb 26, 2025

@justinmc
Thanks for the heads up about the test failures. I've looked into it, but I'm still puzzled since my changes were limited to comments in the basic.dart file. The failing tests are Linux analyze, which seem unrelated to the documentation change. I've rebased against the latest flutter:master, but the failures persist. I'm not familiar with the analyzer or framework test setup, so I'm not sure where to start debugging. Would you (or someone else on the team) be able to take a look and offer some guidance on how to resolve these failures? I really appreciate you taking the time to look into this!

Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

Hey @SunkenInTime welcome! Thanks for contributing!

It looks like the failures are caused by your change, from the output:

 RUNNING: cd .; bin/cache/dart-sdk/bin/dart --enable-asserts /b/s/w/ir/x/w/flutter/dev/bots/analyze_snippet_code.dart --verbose
 workingDirectory: /b/s/w/ir/x/w/flutter, executable: /b/s/w/ir/x/w/flutter/bin/cache/dart-sdk/bin/dart, arguments: [--enable-asserts, /b/s/w/ir/x/w/flutter/dev/bots/analyze_snippet_code.dart, --verbose]
 packages/flutter/lib/src/widgets/basic.dart:1737:17: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
 packages/flutter/lib/src/widgets/basic.dart:1738:16: Abstract classes can't be instantiated (expression) (instantiate_abstract_class)
 packages/flutter/lib/src/widgets/basic.dart:1738:16: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
 packages/flutter/lib/src/widgets/basic.dart:1747:17: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
 packages/flutter/lib/src/widgets/basic.dart:1748:16: Abstract classes can't be instantiated (expression) (instantiate_abstract_class)
 packages/flutter/lib/src/widgets/basic.dart:1748:16: Use 'const' with the constructor to improve performance (expression) (prefer_const_constructors)
 Found 6 snippet code errors.

Can you update to resolve these?

@SunkenInTime
Copy link
Author

Hi @Piinks , thanks for the heads up! I didn't realize that it lints the code snippets 😭. I've made the changes to the affected lines. I would also like to know if the text widgets used there are appropriate. Thanks again!

Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

Thanks for helping to make this nuance more clear for everyone. Just a bunch of suggestions about the wording, except for the part about double quotes, which I think is breaking the analyzer.

@SunkenInTime
Copy link
Author

@justinmc Apologies for taking so long, just made the proposed fixes to the commit! Thanks for the guidance 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework flutter/packages/flutter repository. See also f: labels.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants