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

Turn top-library comment into non-dartdoc. #1290

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Conversation

lrhn
Copy link
Member

@lrhn lrhn commented Oct 19, 2023

Prepare for lints 3.0.0 (PR #1289), which will report this as a dangling library comment, when it's probably just not intended a doc comment at all.

Prepare for lints 3.0.0, which reports this as a dangling library comment, when it's probably just not intended a doc comment at all.
@lrhn lrhn requested a review from munificent October 19, 2023 14:44
@munificent
Copy link
Member

It's not the most useful comment in the world, but it is intended to document the purpose of that library. Why is it becoming a lint violation?

Copy link
Member

@natebosch natebosch left a comment

Choose a reason for hiding this comment

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

Why is it becoming a lint violation?

Library level doc comments are expected to be on a library; directive. Using a doc comment on the first import (or other directive) is no longer recommended.

lib/src/debug.dart Outdated Show resolved Hide resolved
Keep as doc-comment, adding the then required `library;` to sit on.

Co-authored-by: Nate Bosch <nbosch@google.com>
@lrhn
Copy link
Member Author

lrhn commented Oct 24, 2023

What Nate says, and I saw this was the only thing blocking #1289.

@lrhn lrhn merged commit 874d511 into main Oct 25, 2023
7 checks passed
@lrhn lrhn deleted the lrhn-patch-dangling-library-doc branch October 25, 2023 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants