docs: document possible errors for nng_pipe_get functions

[flxo]

Add error documentation for pipe option getter functions, including NNG_ENOENT which can be returned when the pipe does not exist.

fixes #2198

Summary by CodeRabbit

• Documentation
  • Added an "Errors" subsection for pipe-related options that enumerates possible return error codes and clarifies which option-accessors may specifically surface memory or storage shortage errors, improving clarity on failure modes for users.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a84392f8-7f69-4263-a23e-9926db669002

📥 Commits

Reviewing files that changed from the base of the PR and between b3f2dac and 7297c51.

📒 Files selected for processing (1)

• docs/ref/api/pipe.md

✅ Files skipped from review due to trivial changes (1)

• docs/ref/api/pipe.md

---

📝 Walkthrough

Walkthrough

Added an "Errors" subsection to the nng_pipe_get_strlen (and related nng_pipe_get_*) documentation, enumerating possible return error codes: NNG_ENOENT, NNG_ENOTSUP, NNG_EBADTYPE, NNG_ENOMEM, and NNG_ENOSPC.

Changes

Cohort / File(s)	Summary
Documentation — Pipe API docs/ref/api/pipe.md	Inserted an "Errors" subsection for nng_pipe_get_strlen and related option-accessors listing possible return codes: NNG_ENOENT (pipe not found), NNG_ENOTSUP (option unsupported), NNG_EBADTYPE (wrong type), NNG_ENOMEM (memory allocation failure for specific functions), and NNG_ENOSPC (insufficient buffer space for certain functions).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped into docs with a nibble and twirl,
Listed errors neat for each pipe in the swirl.
ENOENT now shown, no mystery remains,
Clearer API paths for developers' brains. ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: documenting possible errors for nng_pipe_get functions.
Description check	✅ Passed	The description follows the template format, references the linked issue (#2198), and explains the change, though it could be slightly more detailed.
Linked Issues check	✅ Passed	The pull request meets the objective of issue #2198 by documenting ENOENT as a possible return value for nng_pipe_get functions.
Out of Scope Changes check	✅ Passed	All changes are focused on documenting errors for pipe option getter functions, which is directly related to the linked issue #2198.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

You can disable poems in the walkthrough.

Disable the reviews.poem setting to disable the poems in the walkthrough.