Add example to linter

f3ath · Jul 29, 2020 · d378406 · d378406
1 parent 3e0cff4
commit d378406
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/dart.yml b/.github/workflows/dart.yml
@@ -19,6 +19,6 @@ jobs:
       - name: Install dependencies
         run: pub get
       - name: Analyzer
-        run: dartanalyzer --fatal-infos --fatal-warnings lib test
+        run: dartanalyzer --fatal-infos --fatal-warnings lib test example
       - name: Tests
         run: pub run test
diff --git a/lib/src/json_path.dart b/lib/src/json_path.dart
@@ -5,7 +5,9 @@ import 'package:json_path/src/selector/selector.dart';
 import 'package:json_path/src/state.dart';
 import 'package:json_path/src/tokenize.dart';
 
+/// A JSONPath expression
 class JsonPath {
+  /// Creates an instance from string
   factory JsonPath(String expression) {
     State state = Ready(Root());
     for (final node in Node.build(tokenize(expression)).children) {
@@ -18,7 +20,7 @@ class JsonPath {
 
   final Selector _selector;
 
-  /// Filters the given [json].
+  /// Filters the given [json] object.
   /// Returns an Iterable of all elements found
   Iterable<Result> select(json) => _selector([Result(json, '')]);