Add drawPath documentation about preferring other methods for drawing simple shapes#184253
Merged
Conversation
Member
|
@b-luk did you want to change this from a draft? |
Contributor
Author
|
Marked as ready for review. Forgot about that part. |
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the drawPath method in the Canvas class to recommend using specialized methods like drawRect or drawOval for simple shapes to improve efficiency. Feedback suggests rephrasing the documentation to clarify that the performance benefit comes from avoiding the creation of a Path object.
Comment on lines
+7294
to
+7297
| /// When drawing simple shapes (such as rectangles, ovals, or rounded | ||
| /// rectangles), prefer using methods such as [drawRect], [drawOval], or | ||
| /// [drawRRect] over [drawPath]. Methods that draw simple shapes are generally | ||
| /// more efficient than drawing a [Path]. |
Contributor
There was a problem hiding this comment.
For improved clarity, consider rephrasing this paragraph. The current wording '...more efficient than drawing a [Path]' is slightly ambiguous because [Path] refers to the class, not an action. A more explicit phrasing could better explain the alternative workflow that is being discouraged.
/// When drawing simple shapes (such as rectangles, ovals, or rounded
/// rectangles), prefer using methods such as [drawRect], [drawOval], or
/// [drawRRect] over [drawPath]. These dedicated methods are generally more
/// efficient than creating a [Path] and drawing it with this method.References
- The style guide emphasizes optimizing for readability and ensuring documentation is useful. This change improves both by making the explanation clearer. (link)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2026
…or drawing simple shapes (flutter/flutter#184253)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2026
…or drawing simple shapes (flutter/flutter#184253)
ahmedsameha1
pushed a commit
to ahmedsameha1/flutter
that referenced
this pull request
Apr 14, 2026
… simple shapes (flutter#184253) Add drawPath documentation about preferring other methods for drawing simple shapes Part of flutter#183044 ## Pre-launch 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] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. 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. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [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/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add drawPath documentation about preferring other methods for drawing simple shapes
Part of #183044
Pre-launch Checklist
///).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-assistbot 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.