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.

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

sys/net/nanocoap: improve doc for coap_build_reply() #21155

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

sys/net/nanocoap: improve doc for coap_build_reply() #21155

wants to merge 5 commits into from
+60 −21

Conversation

maribu
Copy link
Member

@maribu maribu commented Jan 22, 2025

Contribution description

As the title says: This improves the doc for coap_build_reply() a bit.

Testing procedure

See generated doc

Issues/PRs references

None

@maribu maribu added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jan 22, 2025
@maribu maribu requested review from benpicco and mguetschow January 22, 2025 21:01
@github-actions github-actions bot added Area: network Area: Networking Area: sys Area: System and removed Area: doc Area: Documentation labels Jan 22, 2025
@maribu maribu mentioned this pull request Jan 22, 2025
Open
@riot-ci
Copy link

riot-ci commented Jan 22, 2025 •
edited
Loading

Murdock results

✔️ PASSED

c07acdb fixup! Update sys/include/net/nanocoap.h

Success Failures Total Runtime
10271 0 10271 09m:05s

Artifacts

mguetschow
mguetschow reviewed Jan 23, 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.

Thanks, nice start! Some suggestions below.

sys/include/net/nanocoap.h Outdated Show resolved Hide resolved
sys/include/net/nanocoap.h Outdated Show resolved Hide resolved
sys/include/net/nanocoap.h Outdated Show resolved Hide resolved
sys/include/net/nanocoap.h Outdated Show resolved Hide resolved
sys/include/net/nanocoap.h Show resolved Hide resolved
sys/include/net/nanocoap.h Outdated Show resolved Hide resolved
sys/include/net/nanocoap.h Show resolved Hide resolved
@maribu
sys/include/net/coap.h: Add COAP_PAYLOAD_MARKER_SIZE
4d8d3cc 
Using a constant is easier than explaining where the magic 1 came from
in size estimations.
@maribu maribu force-pushed the sys/net/nanocoap/coap_build_reply branch 2 times, most recently from ebb6533 to e2464a0 Compare January 23, 2025 10:40
@maribu maribu force-pushed the sys/net/nanocoap/coap_build_reply branch from e2464a0 to 58ca598 Compare January 23, 2025 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mguetschow mguetschow mguetschow left review comments

@benpicco benpicco Awaiting requested review from benpicco

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Area: network Area: Networking Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@maribu @riot-ci @mguetschow