The Wayback Machine - https://web.archive.org/web/20210124112123/https://github.com/platformio/platformio-docs/issues/43
Skip to content
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

Inconsistencies in tutorial documentation #43

Open
Navis-Raven opened this issue Oct 3, 2018 · 0 comments
Open

Inconsistencies in tutorial documentation #43

Navis-Raven opened this issue Oct 3, 2018 · 0 comments

Comments

@Navis-Raven
Copy link

@Navis-Raven Navis-Raven commented Oct 3, 2018

This post follows this one where there is still some unsoved points: #33 (comment)

10.a
11. some are fixed but not all of them the STM32Cube tutorial does not have up to date screenshots: https://docs.platformio.org/en/latest/tutorials/ststm32/stm32cube_debugging_unit_testing.html
23: unsolved.
(24) New one: The note : "2 sec delay is required since the board doesn’t support software resetting via Serial.DTR/RTS"
is missing on this ESP-32 tutorial, isn't it ?
https://docs.platformio.org/en/latest/tutorials/espressif32/arduino_debugging_unit_testing.html

So, to summuarize:
(A) equivalent 10.a:
When opening nRF53-DK tutorial it says to install j link drivers BEFORE beginning the debug session tutorial
However when following the steps of installing drivers, see:
image

However when following the steps of installing drivers, it says to start debug session while the newcommer doesn't have a clue of how to start a debug session (an additionnal instuction should be added on this line, to explain how to start debug session).

(B) eq. 11: The screenshots of STM32Cube are not up to date, the icons does not include the new ones.

(C) eq. 23: in nRF52-DK tutorial the text says to add some functions to the existing code, but the whole code is new.
image
A solution for this inconsistency:
So to correct this problem, in the section writting unit test you can create previous paragraph (between writing unit test and "Test cases can be") accompanied by a source code that manages hello_world strings, And then you can explain "but as we cannot easily verify the content we need unit testing." And only after this you can say in the next paragraph: "we need to ADD four functions etc..." to test our code.
And then the source code which tests the strings. (the source code will be adapted to the previous).

(D) eq. 24: The note : "2 sec delay is required since the board doesn’t support software resetting via Serial.DTR/RTS"
is missing on this ESP-32 tutorial, isn't it ?
https://docs.platformio.org/en/latest/tutorials/espressif32/arduino_debugging_unit_testing.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant