Skip to content

core/lib/clist: fix example of clist_foreach usage in docs#21848

Merged
crasbe merged 1 commit intoRIOT-OS:masterfrom
leandrolanzieri:pr/fix_clist_doc
Nov 5, 2025
Merged

core/lib/clist: fix example of clist_foreach usage in docs#21848
crasbe merged 1 commit intoRIOT-OS:masterfrom
leandrolanzieri:pr/fix_clist_doc

Conversation

@leandrolanzieri
Copy link
Copy Markdown
Contributor

Contribution description

#7768 introduced an optional argument when using clist_foreach, but the main module documentation was not updated to reflect the API change. This updates the example, and fixes some minor Doxygen rendering issues.

Testing procedure

Check the documentation.

Issues/PRs references

#7768

Also fix some doxygen rendering issues.
@github-actions github-actions bot added the Area: core Area: RIOT kernel. Handle PRs marked with this with care! label Nov 5, 2025
@leandrolanzieri leandrolanzieri added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Nov 5, 2025
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Nov 5, 2025
Copy link
Copy Markdown
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

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

While I think it would be nice to have an example including the optional argument, you don't have to come up with something here. It's already good that the documentation is fixed.

@crasbe crasbe added the CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs label Nov 5, 2025
@riot-ci
Copy link
Copy Markdown

riot-ci commented Nov 5, 2025

Murdock results

✔️ PASSED

79a54c5 core/lib/clist: fix example of clist_foreach usage

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

Artifacts

@crasbe crasbe added this pull request to the merge queue Nov 5, 2025
Merged via the queue into RIOT-OS:master with commit 91daf56 Nov 5, 2025
29 checks passed
@leandrolanzieri leandrolanzieri added this to the Release 2026.01 milestone Jan 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: core Area: RIOT kernel. Handle PRs marked with this with care! CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants