summaryrefslogtreecommitdiffstats
path: root/docs/reference.rst
diff options
context:
space:
mode:
authorPetteri Aimonen <jpa@git.mail.kapsi.fi>2012-12-06 11:13:53 +0200
committerPetteri Aimonen <jpa@git.mail.kapsi.fi>2012-12-06 11:13:53 +0200
commit871e5be9dd6bb69e2bee2d8e23d27b89285c8f8b (patch)
treed0c5c5e364a753579892436d8478ffd0507aec27 /docs/reference.rst
parent068de05c51b7b46e33ef87b8d78c9dda6704abc8 (diff)
Fix small error in field callback documentation.
Update issue 44 Status: FixedInGit
Diffstat (limited to 'docs/reference.rst')
-rw-r--r--docs/reference.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/reference.rst b/docs/reference.rst
index 371c155a..2b10c2ee 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -381,7 +381,7 @@ Remove the data for a field from the stream, without actually decoding it::
For decoding numeric (including enumerated and boolean) values, use `pb_decode_varint`_, `pb_decode_svarint`_, `pb_decode_fixed32`_ and `pb_decode_fixed64`_. They take a pointer to a 32- or 64-bit C variable, which you may then cast to smaller datatype for storage.
- For decoding strings and bytes fields, the length has already been decoded. You can therefore check the total length in *stream->state* and read the data using `pb_read`_.
+ For decoding strings and bytes fields, the length has already been decoded. You can therefore check the total length in *stream->bytes_left* and read the data using `pb_read`_.
Finally, for decoding submessages in a callback, simply use `pb_decode`_ and pass it the *SubMessage_fields* descriptor array.