pkg/uwb-dw1000: fix README include#20440
Merged
benpicco merged 1 commit intoRIOT-OS:masterfrom Feb 29, 2024
Merged
Conversation
github-actions
bot
added
Area: doc
crasbe
changed the title
benpicco
approved these changes
Feb 29, 2024
Contributor
|
Please also amend your commit title like you did with the PR title |
benpicco
added
Impact: minor
The doc.txt file referred to the incorrect README.md file (from pkg/ucglib) instead of pkg/uwb-dw1000, which led to the generation of incorrect Doxygen documentation.
Contributor
Author
|
I changed the commit title. Sorry for the oversight, this is new (git) territory for me. |
benpicco
added
the
CI: ready for build
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contribution description
The doc.txt file of the uwb-dw1000 package included to the incorrect README.md file (from pkg/ucglib) instead of pkg/uwb-dw1000, which led to the generation of incorrect Doxygen documentation.
Testing procedure
With the change applied, the Doxygen documentation should still successfully build and now have the correct description of the UWB-DW1000 package.
Issues/PRs references
No separate issue opened.