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

Fix broken comment references in devtools_app_shared #8863

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

srawlins
Copy link
Contributor

@srawlins srawlins commented Feb 6, 2025

Some broken references were just typos. Some were pointing to properties of non-local types. Some were found on a class's doc comment, while refering to parameters in the constructor, which is not possible to do.

/// Each child in [children] must have an accompanying header in [header]. Since
/// each header must be a [PreferredSizeWidget], it is common to use the shared
/// widgets [AreaPaneHeader] or [BlankHeader] for the column [headers].
/// Each child in `children` must have an accompanying header in [headers].
Copy link
Member

Choose a reason for hiding this comment

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

is there a lint to catch these types of errors?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is; the comment_references lint. I hope to turn it on after fixing these.

@srawlins srawlins merged commit ae0a811 into flutter:master Feb 7, 2025
25 checks passed
@srawlins srawlins deleted the comm-refs-shared branch February 7, 2025 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants