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

comment_references rule false-positive on markdown code blocks. #57370

Closed
dikmax opened this issue Aug 29, 2016 · 6 comments
Closed

comment_references rule false-positive on markdown code blocks. #57370

dikmax opened this issue Aug 29, 2016 · 6 comments
Assignees
Labels
analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@dikmax
Copy link

dikmax commented Aug 29, 2016

Consider this example:

/// Some description
///
/// ```dart
/// /**
///  * Throws a [StateError] if ...
///  * similar to [anotherMethod], but ...
///  */
/// ```
///
/// More text.
void method() {}

In that case [StateError] and [anotherMethod] are not references.

@pq
Copy link
Member

pq commented Aug 29, 2016

@scheglov : does analyzer do the right thing here? I'm guessing it's trying to resolve StateError and anotherMethod as if they were references.

@pq pq added the type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) label Aug 29, 2016
@bwilkerson
Copy link
Member

I suspect that's true. I don't think our parser is very intelligent about handling code blocks.

@scheglov scheglov self-assigned this Aug 29, 2016
@scheglov
Copy link
Contributor

Yes, we handle single line GitHub style code blocks, but we don't handle multi-line GitHub style comments.

@pq
Copy link
Member

pq commented Aug 29, 2016

Yes, we handle single line GitHub style code blocks, but we don't handle multi-line GitHub style comments.

Should we? Does dartdoc? (cc @keertip)

@scheglov
Copy link
Contributor

scheglov commented Sep 1, 2016

@scheglov
Copy link
Contributor

scheglov commented Sep 1, 2016

75d1ff0

@scheglov scheglov closed this as completed Sep 1, 2016
@devoncarew devoncarew added analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. labels Nov 18, 2024
@devoncarew devoncarew transferred this issue from dart-lang/linter Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

5 participants