Fix small error in field callback documentation.
authorPetteri Aimonen <jpa@git.mail.kapsi.fi>
Thu, 6 Dec 2012 09:13:53 +0000 (11:13 +0200)
committerPetteri Aimonen <jpa@git.mail.kapsi.fi>
Thu, 6 Dec 2012 09:13:53 +0000 (11:13 +0200)
Update issue 44
Status: FixedInGit

docs/reference.rst

index 371c155..2b10c2e 100644 (file)
@@ -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.