WMT-GmbH / pn532

no_std implementation of the Pn532 protocol using embedded_hal traits
Apache License 2.0
20 stars 19 forks source link

`requests::Command` needs better documentation for it's variants #15

Closed JohnTheCoolingFan closed 8 months ago

JohnTheCoolingFan commented 9 months ago

Currently the doc comments refer to some document I assume, which is not a very good practive. I think it should contain an explanation, a description of the command variant.

JohnTheCoolingFan commented 9 months ago

I might do a PR on this because the hardest part (for me) would probably be finding the document that is being referred to here. No promises.

dimpolo commented 8 months ago

I get your point, and usually I would inline the documentation. However in this case a lot of commands are very complicated and require a lot of documentation. If you find a good way to do this, I would welcome a PR. Here's the User Manual: https://www.nxp.com/docs/en/user-guide/141520.pdf