Skip to content

buffer: documentation incorrect #5682

@fb55

Description

@fb55

The documentation of writeU?Int(8|((16|32)[BL]E))? states that the return value is the number of bytes written, while it actually is the offset plus this number.

This is inconsistent with a plain write, which returns only the bytes written, so before sending a PR, I wanted to ask which option is preferred: Correct the code (which might break modules & backwards compatibility) or fix the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bufferIssues and PRs related to the buffer subsystem.docIssues and PRs related to the documentations.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions