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

Writing documentation related to SPI slave. #14457

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

FelipeMdeO
Copy link
Contributor

This documentation refers to PR: apache/nuttx-apps#2765

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Oct 22, 2024
@nuttxpr
Copy link

nuttxpr commented Oct 22, 2024

[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.

@acassis
Copy link
Contributor

acassis commented Oct 22, 2024

@FelipeMdeO please fix the issue:

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

Copy link
Contributor

@cederom cederom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @FelipeMdeO !! :-)

@cederom
Copy link
Contributor

cederom commented Oct 22, 2024

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

Copy link
Contributor

@cederom cederom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo fix plz :-)

@FelipeMdeO
Copy link
Contributor Author

Hello @cederom.

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

@FelipeMdeO FelipeMdeO requested a review from cederom October 24, 2024 12:54
@xiaoxiang781216 xiaoxiang781216 merged commit d291ed0 into apache:master Oct 24, 2024
3 checks passed
@FelipeMdeO FelipeMdeO deleted the spislv-createDoc branch October 24, 2024 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants