Skip to content

Lint to ensure identifiers referenced in docs are in-scope. #57330

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.

Sign up for GitHub

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

Jump to bottom
Closed
pq opened this issue May 12, 2016 · 2 comments
Closed

Lint to ensure identifiers referenced in docs are in-scope. #57330

pq opened this issue May 12, 2016 · 2 comments
Labels
devexp-linter Issues with the analyzer's support for the linter package legacy-area-analyzer Use area-devexp instead. linter-lint-request type-enhancement A request for a change that isn't a bug

Comments

@pq
Copy link
Member

pq commented May 12, 2016

Picking up from #26158 (Analyzer should catch dangling [Foo] references in dartdocs). After some discussion we agreed that this would best be suited as a lint.
@pq pq added type-enhancement A request for a change that isn't a bug linter-lint-request labels May 12, 2016
@pq pq mentioned this issue May 12, 2016
Closed
@pq
Copy link
Member Author

pq commented May 12, 2016

https://codereview.chromium.org/1978603003/

pq referenced this issue in dart-archive/linter May 13, 2016
@pq
Lint to detect dangling identifiers in docs (#240).
1659848 
Implements: https://github.com/dart-lang/linter/issues/240.

BUG=
[email protected], [email protected]

Review URL: https://codereview.chromium.org//1978603003 .
@pq
Copy link
Member Author

pq commented May 13, 2016

Implemented w/ dart-archive/linter@1659848.

@pq pq closed this as completed May 13, 2016
pq referenced this issue in dart-archive/linter May 18, 2016
@pq
Linter version 0.1.17.
8e1873b 
Introduces:

* Fix to `public_member_api_docs` to check for documented getters when checking setters (#237).
* New `iterable_contains_unrelated_type` lint to detect when `Iterable.contains` is invoked with an object of an unrelated type.
* New `comment_references` lint to ensure identifiers referenced in docs are in scope (#240).

BUG=
[email protected]

Review URL: https://codereview.chromium.org//1992693003 .
pq referenced this issue in pq/flutter May 18, 2016
@pq
Update to new analyzer and linter.
f91cf1c 
Notably, this will allow us to play with

* the fixed `public_member_api_docs` that now checks for documented getters when checking setters (https://github.com/dart-lang/linter/issues/237), and
* the new `comment_references` lint that ensures identifiers referenced in docs are in scope (https://github.com/dart-lang/linter/issues/240).
pq referenced this issue in pq/flutter May 18, 2016
@pq
Update to new analyzer and linter.
addc888 
Notably, this will allow us to play with

* the fixed `public_member_api_docs` that now checks for documented getters when checking setters (https://github.com/dart-lang/linter/issues/237), and
* the new `comment_references` lint that ensures identifiers referenced in docs are in scope (https://github.com/dart-lang/linter/issues/240).
@pq pq mentioned this issue May 18, 2016
Merged
pq referenced this issue in pq/flutter May 19, 2016
@pq
Cleanup dangling comment references.
1a6f499 
Quick pass at fixing a few dangling references as revealed by the new `comment_references` lint (https://github.com/dart-lang/linter/issues/240).

There's a bunch more to do here before we can turn it on by default (~430 lints as of now).  Many of them are a simple matter of adding an import (e.g., `dart:async` for library docs that reference `Future`) but others will require a bit of thought.  Probably best done by the folks writing the code. :)
@pq pq mentioned this issue May 19, 2016
Merged
stuartmorgan-g referenced this issue in stuartmorgan-g/packages Apr 30, 2021
@pq
Cleanup dangling comment references.
b2d1c5b 
Quick pass at fixing a few dangling references as revealed by the new `comment_references` lint (https://github.com/dart-lang/linter/issues/240).

There's a bunch more to do here before we can turn it on by default (~430 lints as of now).  Many of them are a simple matter of adding an import (e.g., `dart:async` for library docs that reference `Future`) but others will require a bit of thought.  Probably best done by the folks writing the code. :)
@devoncarew devoncarew added devexp-linter Issues with the analyzer's support for the linter package legacy-area-analyzer Use area-devexp instead. labels Nov 18, 2024
@devoncarew devoncarew transferred this issue from dart-archive/linter Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
devexp-linter Issues with the analyzer's support for the linter package legacy-area-analyzer Use area-devexp instead. linter-lint-request type-enhancement A request for a change that isn't a bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pq @devoncarew