docs: Rect extension docs is out of date
#1451
Merged
Conversation
This file contains 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
wolfenrain
commented
Mar 14, 2022
| @@ -83,8 +83,7 @@ extension RectExtension on Rect { | |||
| return Rect.fromPoints(Offset(minX, minY), Offset(maxX, maxY)); | |||
| } | |||
|
|
|||
| /// Constructs a rectangle from its center point (specified as a Vector2), | |||
| /// width and height. | |||
| /// Constructs a [Rect] with a [width] and [height] around the [center] point. | |||
| static Rect fromVector2Center({ | |||
There was a problem hiding this comment.
I kinda want to rename this one because I think it was forgotten in the Vector2 migration. But that would be a breaking change (unless we deprecate it and proxy it to the renamed one).
There was a problem hiding this comment.
Do you want to do that change in another PR?
There was a problem hiding this comment.
Lets do that in a follow up if the rest of the team agrees.
| @@ -74,7 +74,7 @@ extension RectExtension on Rect { | |||
| ); | |||
| } | |||
|
|
|||
| /// Creates bounds in from of a [Rect] from a list of [Vector2] | |||
| /// Creates a [Rect] that represents the bounds of the list [pts]. | |||
| static Rect fromBounds(List<Vector2> pts) { | |||
There was a problem hiding this comment.
This name is incorrect in my opinion. It does not create a Rect based on a given bounds, instead it returns a Rect that is the bounds of the list!
So I suggest we also deprecate this and proxy it to a correctly named factory.
wolfenrain
requested review from
spydon,
luanpotter,
erickzanardo and
renancaraujo
spydon
approved these changes
Mar 14, 2022
spydon
reviewed
Mar 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The
Rectextension docs is out of date, and the factory methods were confusing to read, they were not explaining themselves easily so I have updated them as well.Checklist
fix:,feat:,docs:etc).docsand added dartdoc comments with///.examples.Breaking Change
Related Issues