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

dartdoc and comment_references lint disagree on [true] and [false] #808

Closed
pq opened this issue Oct 20, 2017 · 5 comments
Closed

dartdoc and comment_references lint disagree on [true] and [false] #808

pq opened this issue Oct 20, 2017 · 5 comments
Assignees
Labels
type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@pq
Copy link
Member

pq commented Oct 20, 2017

From @kevmoo on October 18, 2017 1:51

If one enables the comment_references lint, doing[true] or [false] is fine.

dartdoc reports these as unresolved-doc-reference

...should be consistent

Copied from original issue: dart-lang/dartdoc#1519

@pq pq added type-enhancement A request for a change that isn't a bug P3 A lower priority bug or feature request labels Oct 20, 2017
@pq
Copy link
Member Author

pq commented Oct 20, 2017

From @kevmoo on October 18, 2017 1:56

FYI @pq

@pq
Copy link
Member Author

pq commented Oct 20, 2017

From @jcollins-g on October 18, 2017 15:13

dartdoc does not currently support keywords in comment references, but this could be added.

@pq
Copy link
Member Author

pq commented Oct 20, 2017

From @devoncarew on October 18, 2017 15:23

We may want to choose to change the lint here. I'd expect the contents of square brackets to generally be something that resolves to a symbol. For this case, the user should probably write:

`true`

@pq
Copy link
Member Author

pq commented Oct 20, 2017

From @jcollins-g on October 18, 2017 15:35

I can also see the argument for [] working for true or false, since functionally those work the same as final global bools and when I'm coding, I don't usually make the distinction in my head that these are keywords.

In general, better synchronization between the linter and dartdoc seems like a good idea if we can find the space for it.

@pq
Copy link
Member Author

pq commented Oct 20, 2017

From @kevmoo on October 18, 2017 15:54

It's not like true exists as a top-level field in dart:core, though.
There is nothing for dartdoc to link to.

I'd rather we change linter, IMHO

On Wed, Oct 18, 2017 at 8:35 AM, jcollins-g notifications@github.com
wrote:

I can also see the argument for [] working for true or false, since
functionally those work the same as final global bools and when I'm coding,
I don't usually make the distinction in my head that these are keywords.

In general, better synchronization between the linter and dartdoc seems
like a good idea if we can find the space for it.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
dart-lang/dartdoc#1519 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AABCikHZSLH9dkc_4_N2i9PfKSxRX5C6ks5sthrNgaJpZM4P9DKP
.

@pq pq added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) and removed type-enhancement A request for a change that isn't a bug P3 A lower priority bug or feature request labels Oct 20, 2017
@pq pq self-assigned this Oct 20, 2017
pq added a commit that referenced this issue Oct 20, 2017
Update `comment_references` to check for keywords that are not treated as references by the parser
but should be flagged by the linter.

Fixes: #808.
@pq pq closed this as completed in #809 Oct 20, 2017
pq added a commit that referenced this issue Oct 20, 2017
* Fix comment_references to flag keywords (#808).

Update `comment_references` to check for keywords that are not treated as references by the parser
but should be flagged by the linter.

Fixes: #808.

* loop fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

1 participant