[NikhitaR-IFX]

Summary

• Updated quickref sections to point to pin diagrams (in example snippets)
• Updated safe mode documentation

Generative AI

I did not use generative AI tools when creating this PR..

[jaenrig-ifx]

I don't the need of redundant comments (literally repeating what the signature already clearly states) in the snippets. To me, they create clutter and noise.
But I let that to @ederjc.

The rest looking good! 👍

[ederjc]

I don't the need of redundant comments (literally repeating what the signature already clearly states) in the snippets. To me, they create clutter and noise. But I let that to @ederjc.

The rest looking good! 👍

Please point out to which part of the PR you're referring.

[jaenrig-ifx]

I don't the need of redundant comments (literally repeating what the signature already clearly states) in the snippets. To me, they create clutter and noise. But I let that to @ederjc.
The rest looking good! 👍

Please point out to which part of the PR you're referring.

For example:
https://github.com/Infineon/micropython/pull/251/changes#diff-60213d3c70dd0b209357a3dfecdb308e0eac2568d746b66d7c2d71c8cc12a3b5R280

pwm = PWM('P9_0', freq=50, duty_u16=8192) # PWM is initialised with respective frequency & duty cycle given as raw value.

Such comment does not really add any additional information which the code does not provide itself.

Comments that could provide some additional info:

• that duty has Hz units.
• If the constructor already starts the PWM signal, or just inits it.
• The equivalent duty %
• ... any non self-explanatory info which is not also documented in the ref API.

Also, the pins are not really exclusive for the CY8CPROTO-062-4343W, but many of them make sense for that board, because they are exposed only in that board .
In any case, maybe a note at the beginning of the section can be added mentioning that the snippets pins are selected with CY8CPROTO-062-4343W in mind, and remind the user to check the appropriate/desired pins for the other boards in the supported board section.

[ederjc]

In my perception the "redundant" comments have been there before and Nikhita made them appear more consistently.

Fine for me, rather we document a bit more then too little. This is also targeting beginners, which might benefit from that.

[NikhitaR-IFX]

The build failure is not related to docs itself but mbedtls version (as discussed). Let me know if I should bypass rules and merge or we need to keep it on hold until resolved?