Docs: update specification of capy::read

[akrzemi1]

This makes the description of capy::read closer to the STD specification.

[cppalliance-bot]

An automated preview of the documentation is available at https://291.capy.prtest3.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-05-29 21:36:43 UTC

[cppalliance-bot]

GCOVR code coverage report https://291.capy.prtest3.cppalliance.org/gcovr/index.html
LCOV code coverage report https://291.capy.prtest3.cppalliance.org/genhtml/index.html
Coverage Diff Report https://291.capy.prtest3.cppalliance.org/diff-report/index.html

Build time: 2026-05-29 21:51:57 UTC

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.24%. Comparing base (7ab1157) to head (2b1951c).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #291   +/-   ##
========================================
  Coverage    92.24%   92.24%           
========================================
  Files          164      164           
  Lines         8862     8862           
========================================
  Hits          8175     8175           
  Misses         687      687           

Flag	Coverage Δ
linux	92.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
include/boost/capy/read.hpp	100.00% <100.00%> (ø)
include/boost/capy/write.hpp	100.00% <ø> (ø)

... and 2 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ab1157...2b1951c. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.