[riot-notifications] [RIOT-OS/RIOT] nanocoap docs: buffer/packet API distinction not referenced when used (#12201)

chrysn notifications at github.com
Wed Sep 11 16:43:09 CEST 2019

#### Steps to reproduce the issue

Start building nanocoap packages using the Packet API which is advertised as one of the two possible APIs towards the nanocoap message.

Then have another look at your message using any of the `coap_opt_get_*` functions which all internally use coap_find_option.

#### Expected results

The documentation should have pointed out that all these functions require a message built with the buffer API. (For users who know the implementation that's kind of obvious, and in most cases it won't matter too much because read options are mostly used with incoming messages that were parsed into the Buffer API, but that's not explicit.)

The best indication the reader gets at this is that the section including the read options is labelled "Read options from a parsed packet".

#### Next steps

I'll file a PR based on the currently open changes like #12075 -- @kb2ma, any other PRs I should look into before writing this?

You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190911/9a1e6c24/attachment.htm>

More information about the notifications mailing list