boostorg / boostorg/iostreams

Inconsistent documentation on return value of write() for SeekableDevice

Open
#75 1 comment 0 reactions 0 assignees View on GitHub
doc
Dominant language
C
Stars
48
Forks
124
PR merge metrics
No merged PRs in 30d

Description

In the `SeekableDevice` documentation, the description of `write()` says:

https://github.com/boostorg/iostreams/blob/29a831798ec6337848d1f2e8595b59e5503e4f21/doc/concepts/seekable_device.html#L58-L60

but the function signature says the return value is `void`:

https://github.com/boostorg/iostreams/blob/29a831798ec6337848d1f2e8595b59e5503e4f21/doc/concepts/seekable_device.html#L56

Should that say `std::streamsize` instead?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.