-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
boards/nrf52dk: fix doc #18646
boards/nrf52dk: fix doc #18646
Conversation
Can confirm that the LEDs and buttons work. On documentation changes, I think that the old picture should be removed (or there should be text that there are nRF52-DK compatible boards around that look like that ... but it doesn't look compatible to me). Other than that, looks good. I'd prefer to only start cleaning up boards once we have consensus on #18589 and thus a good reason to rename boards around -- but it seems that that process is broken. |
The board definition of the `nrf52dk` was likely created for some clone board. However, an official board name nRF52 DK provided by Nordic also exists. This resulted in previous contributors in confusing this with the official board and "fixing" the board definition to match the nRF52 DK board. Or maybe it always has been meant to be the official board and someone just added a wrong image to it. In either case, this brings the documentation back in alignment with the code by replacing references to some random clone board and the image of the random clone board with those to/of the official Nordic nRF52 DK board.
6313639
to
b8936c7
Compare
Agreed. Actually, the commit and PR description claim I already did so, but I seem to have forgot to do that. I fixed and directly squashed.
I would generally agree if this is about renaming and cleaning. But IMO this here is rather a bug fix. The board in the picture has no buttons, no LEDs, no integrated J-Link. Yet, the board definitions have LEDs, buttons and a J-Link programmer set up all in alignment with the genuine nRF52 DK board. So the doc and the code are indeed contradicting each other. At this point, we should either fix the doc to match the code, or adapt the code to indeed implement the clone board the doc claims it implements. IMO it is easier and more sensible to fix the doc. Looking at the git log it seems that no only I have been using the board definition with genuine nRF52 DK boards without ever looking into the rendered doc, but at least @aabadie and @fjmolinas seem to have also done so. |
Btw: A
Another
Judging from the name |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, this is more of a bug fix. Thanks for fixing this.
Contribution description
The board definition of the
nrf52dk
was likely created for some clone board. However, an official board name nRF52 DK provided by Nordic also exists. This resulted in previous contributors in confusing this with the official board and "fixing" the board definition to match the nRF52 DK board.Or maybe it always has been meant to be the official board and someone just added a wrong image to it.
In either case, this brings the documentation back in alignment with the code by replacing references to some random clone board and the image of the random clone board with those to/of the official Nordic nRF52 DK board.
Testing procedure
Proof reading the doc should be sufficient. In addition, one may want to check that e.g. the button and LED definitions in SAUL indeed work with a legitimate nRF52 DK board (it does so for me).
Issues/PRs references
None