ludocode / mpack

MPack - A C encoder/decoder for the MessagePack serialization format / msgpack.org[C]
MIT License
521 stars 82 forks source link

Fix a discrepancy in documentation concerning *_optional stuff #72

Closed shamazmazum closed 4 years ago

shamazmazum commented 4 years ago

Hello! Functions like mpack_node_map_foo_optional() return a missing node if there is no such key in the map. The documentation is somewhat unclear for this case: you provide correct documentation after @return blocks, but the descriptions for these functions mention nil node, which is only returned in the case of error.

This pull request fixes documentation, providing the correct returned value.

ludocode commented 4 years ago

Thanks!