Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
10.77k
stars
6.57k
forks
source link
Documentation: zephyr-app-commands where goals are more than one word are badly rendered #64130
Closed
aescolar closed 1 year ago
Describe the bug In the documentation, there is a few places where the source rst tries to define a
zephyr-app-commands
with a multiword "goal", but the rendered version is split into one line per word See for example: https://docs.zephyrproject.org/latest/samples/boards/nrf/nrf53_sync_rtc/README.html#building-the-application-for-nrf5340dk-nrf5340-cpuapp https://docs.zephyrproject.org/latest/boards/arm/adafruit_itsybitsy_m4_express/doc/index.html#debugging Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/boards/nrf/nrf53_sync_rtc/README.rst?plain=1#L31 https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/arm/adafruit_itsybitsy_m4_express/doc/index.rst?plain=1#L182Expected behavior The command in the documentation is correct
Impact Confused readers
Logs and console output See above