nuttx icon indicating copy to clipboard operation
nuttx copied to clipboard

Writing documentation related to SPI slave.

Open FelipeMdeO opened this issue 1 year ago • 2 comments

This documentation refers to PR: https://github.com/apache/nuttx-apps/pull/2765

FelipeMdeO avatar Oct 22 '24 13:10 FelipeMdeO

[Experimental Bot, please feedback here]

Fill In The Commit Message: This PR contains a Commit with an Empty Commit Message. Please fill in the Commit Message with the PR Summary.

I lack the ability to access external websites or specific files online, including the content of the provided pull request link. Therefore, I cannot determine if the PR meets the NuttX requirements.

To assess this, you would need to check the PR for the information outlined in the "Summary" and "Impact" sections. Specifically, ensure the PR description clearly articulates:

  • The reason for the change: Is it a bug fix, update, or new feature?
  • The scope of the change: What code is affected, and how does it work differently?
  • The impact of the change: This includes detailing any effects on users, the build process, hardware, documentation, security, compatibility, and anything else relevant.
  • Testing details: The PR should contain information about the testing environment (host and target) and the testing logs before and after the change.

By verifying the presence and completeness of this information in the PR description, you can determine if it meets the NuttX requirements.

nuttxpr avatar Oct 22 '24 13:10 nuttxpr

@FelipeMdeO please fix the issue:

/home/runner/work/nuttx/nuttx/Documentation/applications/examples/spislv_test/index.rst:2:Title underline too short.

acassis avatar Oct 22 '24 13:10 acassis

Ah, typo in underline syntax (one = missing):

Warning, treated as error:
/home/runner/work/nuttx/nuttx/Documentation/applications/examples/spislv_test/index.rst:2:Title underline too short.

``spislv`` SPI slave example
===========================
make: *** [Makefile:47: html] Error 2

cederom avatar Oct 22 '24 16:10 cederom

Hello @cederom.

I am sending documentation again, now I take care with build issues and improve text, following @acassis instructions.

FelipeMdeO avatar Oct 24 '24 12:10 FelipeMdeO