remove [new from docs
#8986
remove [new from docs
#8986
Conversation
|
I'm not such how dartdoc handles comment references (as dartdoc and navigation don't always have the same behaviour - see dart-lang/sdk#36974) but in code navigation |
|
For named constructors you definitely don't need the new - I've seen that working. For default constructors I'm not sure what's better. I could take this out for defaults. /cc @gspencergoog who might know more on this |
|
I think this is fine. In IntelliJ at least if you Ctrl-click on We actually use that difference in a few places (e.g. see TextFormField where it says "For documentation about the various parameters, see the TextField class and new TextField, the constructor.") I'm not sure the distinction is all that relevant most times, but when it is, it's important to go where the user thinks they're going. I'd just make sure to look at each instance of removing the |
|
Updated to prevserve new where it seems to make sense. |
lib/ui/geometry.dart
Outdated
| @@ -1689,7 +1689,7 @@ class RSTransform { | |||
| /// to factor out the computations of the sine and cosine of the rotation | |||
| /// (which are computed each time this constructor is called) and reuse them | |||
| /// over multiple [RSTransform] objects, it may be more efficient to directly | |||
| /// use the more direct [new RSTransform] constructor instead. | |||
There was a problem hiding this comment.
I think it refers to constructor here
lib/ui/painting.dart
Outdated
| @@ -3553,7 +3553,7 @@ class Canvas extends NativeFieldWrapperClass2 { | |||
| /// | |||
| /// To align the text, set the `textAlign` on the [ParagraphStyle] object | |||
| /// passed to the [new ParagraphBuilder] constructor. For more details see | |||
| /// [TextAlign] and the discussion at [new ParagraphStyle]. | |||
There was a problem hiding this comment.
The discussion mentioned seems to be on new ParagraphStyle
lib/ui/text.dart
Outdated
| /// The width influences how ellipses are applied. See the discussion at [new | ||
| /// ParagraphStyle] for more details. | ||
| /// The width influences how ellipses are applied. See the discussion at | ||
| /// [ParagraphStyle] for more details. |
| /// See the discussion of the `maxLines` and `ellipsis` arguments at [new | ||
| /// ParagraphStyle]. | ||
| /// See the discussion of the `maxLines` and `ellipsis` arguments at | ||
| /// [new ParagraphStyle]. |
There was a problem hiding this comment.
This one is ok, right? I just moved new down to the next line.
…2868) flutter/engine@b6981a3...065fe5b git log b6981a3..065fe5b --no-merges --oneline 065fe5b remove unnecessary `[new` from docs (flutter/engine#8986) The AutoRoll server is located here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+/master/autoroll/README.md If the roll is causing failures, please contact the current sheriff ([email protected]), and stop the roller if necessary.
|
BTW, also see dart-lang/dartdoc#1850. |
Dartdoc is canonical. Whatever we do, please make sure it works in dartdocs (i.e. that we can link to constructors when we need to), and that it is documented in the style guide. |
…utter#32868) flutter/engine@b6981a3...065fe5b git log b6981a3..065fe5b --no-merges --oneline 065fe5b remove unnecessary `[new` from docs (flutter/engine#8986) The AutoRoll server is located here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+/master/autoroll/README.md If the roll is causing failures, please contact the current sheriff ([email protected]), and stop the roller if necessary.
Missed these in the PR where I got rid of optional news.