Skip to content

Conflicting API docs for RenderObjects #115525

@matthew-carroll

Description

@matthew-carroll

The following screenshot shows the current API docs for the detach() method in AbstractNode. The instructions appear to conflict. We're told "first call their inherited detach method, and then detach all their children", but we're also told "this method should end with a call to the inherited method, as in super.detach()". We're told that "super.detach()" should be the first thing called, but also the last thing called.

There may be similar issues with other docs. The line "Implementations of this method should end with a call to the inherited method, as in super.detach()." is repeated in a similar fashion for some other similar APIs. I suggest doing an audit.

Screen Shot 2022-11-16 at 8 14 02 PM

Metadata

Metadata

Assignees

Labels

P2Important issues not at the top of the work listd: api docsIssues with https://api.flutter.dev/found in release: 3.3Found to occur in 3.3found in release: 3.6Found to occur in 3.6frameworkflutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onteam-frameworkOwned by Framework teamtriaged-frameworkTriaged by Framework team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions