Skip to content

Commit df01044

Browse files
committed
Added links.
1 parent bae8023 commit df01044

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

.github/workflows/dart.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ jobs:
3131
- name: Install dependencies
3232
run: dart pub get
3333

34-
- name: Install dependencies for test_types
35-
working-directory: example/test_types
36-
run: dart pub get
34+
# - name: Install dependencies for test_types
35+
# working-directory: example/test_types
36+
# run: dart pub get
3737

3838
# Uncomment this step to verify the use of 'dart format' on each commit.
3939
- name: Verify formatting

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ Read.addDecoder(const AnnotationDecoder());
8585

8686
The example below show how to register a decoder for a Dart `Enum` and read
8787
an instance of the enumeration. In this case, instead of creating a custom
88-
class we just register and instance of the already defined generic class
89-
`EnumDecoder<E extends Enum>`:
88+
decoder class we just register an instance of the already defined generic class
89+
[`EnumDecoder`][EnumDecoder]:
9090

9191
<details> <summary> Click to show source-code. </summary>
9292

@@ -222,9 +222,15 @@ listObj.readList<List<String>>(): [[a], [b]]
222222
## Limitations
223223

224224
1) Constants retrievable with [`Reader`][Reader] must have
225-
a built-in Dart type, a type made available by depending on a package, or a type defined in the file being read.
225+
a built-in Dart type, a type made available by depending on
226+
a package, or a type defined in the file being read.
226227

227-
2) Defining decoder functions for each data-type has its obvious limitiations when it comes to *generic types*. In practice, however, generic classes are often designed in such a manner that only few type parameters are valid or likely to be useful. Constants that need to be retrieved during the source-generation process are most likely *annotations* and *simple data-types* that convey information to source code generators.
228+
2) Defining decoder functions for each data-type has its obvious limitiations when it comes to *generic types*.
229+
In practice, however, generic classes are often designed in such a manner
230+
that only few type parameters are valid or likely to be useful.
231+
Constants that need to be retrieved during the source-generation
232+
process are most likely *annotations* and *simple data-types* that
233+
convey information to source code generators.
228234

229235
## Examples
230236

@@ -245,6 +251,8 @@ Please file feature requests and bugs at the [issue tracker].
245251

246252
[DartObject]: https://pub.dev/documentation/analyzer/latest/dart_constant_value/DartObject-class.html
247253

254+
[EnumDecoder]: https://pub.dev/packages/generic_reader/EnumDecoder.html
255+
248256
[example]: https://github.com/simphotonics/generic_reader/tree/main/example
249257

250258
[Reader]: https://pub.dev/packages/generic_reader/Reader.html

example/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ Please file feature requests and bugs at the [issue tracker].
1414

1515
[issue tracker]: https://github.com/simphotonics/generic_reader/issues
1616

17+
[DartObject]: https://pub.dev/documentation/analyzer/latest/dart_constant_value/DartObject-class.html
18+
1719
[Reader]: https://pub.dev/packages/generic_reader/Reader.html

0 commit comments

Comments
 (0)