Skip to content
This repository has been archived by the owner on Aug 1, 2019. It is now read-only.

Commit

Permalink
comment linter issues
Browse files Browse the repository at this point in the history
  • Loading branch information
kevmoo committed May 20, 2016
1 parent 83ae219 commit dd8ed1b
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .analysis_options
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linter:
rules:
- comment_references
2 changes: 2 additions & 0 deletions lib/src/class.dart
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ class VMClassRef implements VMObjectRef {

/// Evaluates [expression] in the context of this class.
///
/// -- A LOT of these – need a way to reference types in non-imported libs
/// -- requiring an import just for these would REALLY suck.

This comment has been minimized.

Copy link
@kevmoo

kevmoo May 20, 2016

Author Contributor

@pq Often we want to reference types (especially) that are not imported

This comment has been minimized.

Copy link
@pq

pq May 20, 2016

Right. We're having that issue in flutter too. Chime in here: dart-lang/dartdoc#1153. Ideas welcome!

/// Throws a [VMErrorException] if evaluating the expression throws an error.
Future<VMInstanceRef> evaluate(String expression) =>
_scope.evaluate(_id, expression);
Expand Down
1 change: 1 addition & 0 deletions lib/src/error.dart
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ class VMErrorKind {

/// An internal error.
///
/// --- boo! detecting a link as a reference. Easy to fix?

This comment has been minimized.

Copy link
@kevmoo

kevmoo May 20, 2016

Author Contributor

@pq could we detect that this is actually HTML link syntax?

/// These errors should not be exposed—if seen, they should be [reported as
/// bugs](https://github.com/dart-lang/sdk/issues/new).
static const internalError = const VMErrorKind._("InternalError");
Expand Down
1 change: 1 addition & 0 deletions lib/vm_service_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ final _jsonSinkEncoder = new StreamSinkTransformer.fromHandlers(
///
/// [service api]: https://github.com/dart-lang/sdk/blob/master/runtime/vm/service/service.md
///
/// --- no clue why `connect` here is an error, but `getVM` is fine. Help?

This comment has been minimized.

Copy link
@kevmoo

kevmoo May 20, 2016

Author Contributor

@pq Really weird – can't figure this out.

/// Connect to a VM service endpoint using [connect], and use [getVM] to load
/// information about the VM itself.
///
Expand Down

2 comments on commit dd8ed1b

@kevmoo
Copy link
Contributor Author

@kevmoo kevmoo commented on dd8ed1b May 20, 2016

Choose a reason for hiding this comment

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

@pq just fixed a bunch of issues w/ the new lint here – 83ae219

Cool!

But also found some weird behavior. Happy to open issues, but I wanted to give you context.

@pq
Copy link

@pq pq commented on dd8ed1b May 20, 2016

Choose a reason for hiding this comment

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

👍

@kevmoo : issues are welcome!

Please sign in to comment.