Skip to content

Commit fa073c3

Browse files
More clearly document that only needed fields should be listed
1 parent d5d7607 commit fa073c3

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@ fields in a generic way, for example to print the parse results with
136136
just a few lines of code. See the parse and read examples for how this
137137
works.
138138

139+
Note that these examples contain the full list of supported fields,
140+
which causes parsing and printing code to be generated for all those
141+
fields, even if they are not present in the output you want to parse. It
142+
is recommended to limit the list of fields to just the ones that you
143+
need, to make the parsing and printing code smaller and faster.
144+
139145
Parsed value types
140146
------------------
141147
Some values are parsed to an Arduino `String` value or C++ integer type,

examples/parse/parse.ino

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ const char raw[] =
4545

4646
/**
4747
* Define the data we're interested in, as well as the datastructure to
48-
* hold the parsed data.
48+
* hold the parsed data. This list shows all supported fields, remove
49+
* any fields you are not using from the below list to make the parsing
50+
* and printing code smaller.
4951
* Each template argument below results in a field of the same name.
5052
*/
5153
using MyData = ParsedData<

examples/read/read.ino

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313

1414
/**
1515
* Define the data we're interested in, as well as the datastructure to
16-
* hold the parsed data.
16+
* hold the parsed data. This list shows all supported fields, remove
17+
* any fields you are not using from the below list to make the parsing
18+
* and printing code smaller.
1719
* Each template argument below results in a field of the same name.
1820
*/
1921
using MyData = ParsedData<

0 commit comments

Comments
 (0)