Skip to content

Commit a9389cf

Browse files
committed
added clarifying comment
1 parent a8473fe commit a9389cf

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/metadata.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,12 @@ Furthermore, these two sub-schemas must both define objects,
580580
and must not both define the same property:
581581
in other words, the names of the properties in these must not overlap.
582582

583+
When you use this codec, the decoded metadata in python is just a dictionary,
584+
as usual with either the JSON or struct codecs. There is no separation
585+
between the binary-encoded and JSON-encoded entries in metadata;
586+
this happens purely under the hood when encoding (and decoding) the metadata.
587+
See the example below.
588+
583589
#### Binary representation
584590

585591
The underlying structure of the JSON+struct codec is as follows.

0 commit comments

Comments
 (0)