Skip to content

treewide: fix double the in doc and comments #21224

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Feb 19, 2025
Merged

treewide: fix double the in doc and comments #21224

merged 1 commit into from
Feb 19, 2025
+31 −31

Conversation

krzysztof-cabaj
Copy link
Contributor

Contribution description

In PR #21208 I fix double the - the the small typo in ztimer documentation. I checked the whole RIOT project and find much more appearance of this typo. This PR should fix all that small typos.

Testing procedure

Looking at the changes with the successful generation of documentation and Murdock test pass should be enough - as I only touch doxygen and comments.

Issues/PRs references

PR #21208

@github-actions github-actions bot added Platform: ARM Platform: This PR/issue effects ARM-based platforms Area: network Area: Networking Area: doc Area: Documentation Area: tests Area: tests and testing framework Area: pkg Area: External package ports Area: drivers Area: Device drivers Area: boards Area: Board ports Platform: ESP Platform: This PR/issue effects ESP-based platforms Area: cpu Area: CPU/MCU ports Area: sys Area: System Area: examples Area: Example Applications labels Feb 18, 2025
@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Feb 18, 2025
mguetschow
mguetschow approved these changes Feb 18, 2025
View reviewed changes
Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for caring and fixing!

@riot-ci
Copy link

riot-ci commented Feb 18, 2025

Murdock results

✔️ PASSED

a2dfd78 treewide: fix double the in doc and comments

Success Failures Total Runtime
1 0 1 01m:27s

Artifacts

@crasbe
Copy link
Contributor

crasbe commented Feb 18, 2025

While you're at it... this PR touches some of the doc.txt files that are affected by the comment block issue I described in #21220.
With the provided sed command, you can fix that quite quickly.

@krzysztof-cabaj
Copy link
Contributor Author

@mguetschow thanks for ACK.
@crasbe I have just spotted your work described in Issue #21220 - good work! Almost titanic work - with so many files!

I would prefer leave this PR intact, as it concerns small typo, the same in many files. But, when I next time touch doc for nucleo boards - I have some plans in near future, I fix this issue to, and let you know.

@mguetschow
Copy link
Contributor

I would prefer leave this PR intact, as it concerns small typo, the same in many files. But, when I next time touch doc for nucleo boards - I have some plans in near future, I fix this issue to, and let you know.

I agree that it makes sense to fix the asterisks when actually touching the doc.txt files in the future, and less for a treewide typo fix as this one. Let's merge :)

@mguetschow mguetschow added this pull request to the merge queue Feb 19, 2025
Merged via the queue into RIOT-OS:master with commit b0e6fae Feb 19, 2025
27 checks passed
@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mguetschow mguetschow mguetschow approved these changes

@leandrolanzieri leandrolanzieri Awaiting requested review from leandrolanzieri leandrolanzieri is a code owner

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@MichelRottleuthner MichelRottleuthner Awaiting requested review from MichelRottleuthner MichelRottleuthner is a code owner

@MrKevinWeiss MrKevinWeiss Awaiting requested review from MrKevinWeiss MrKevinWeiss is a code owner

@gschorcht gschorcht Awaiting requested review from gschorcht gschorcht is a code owner

@kaspar030 kaspar030 Awaiting requested review from kaspar030 kaspar030 is a code owner

@bergzand bergzand Awaiting requested review from bergzand bergzand is a code owner

@basilfx basilfx Awaiting requested review from basilfx basilfx is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees
No one assigned
Labels
Area: boards Area: Board ports Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation Area: drivers Area: Device drivers Area: examples Area: Example Applications Area: network Area: Networking Area: pkg Area: External package ports Area: sys Area: System Area: tests Area: tests and testing framework CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Platform: ARM Platform: This PR/issue effects ARM-based platforms Platform: ESP Platform: This PR/issue effects ESP-based platforms
Projects
None yet
Milestone
Release 2025.04
Development

Successfully merging this pull request may close these issues.
4 participants
@krzysztof-cabaj @riot-ci @crasbe @mguetschow