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.

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

Update docs #4426

Draft
wants to merge 5 commits into
base: v1.x
Choose a base branch
from
Draft

Update docs #4426

wants to merge 5 commits into from

Conversation

saghul
Copy link
Member

@saghul saghul commented May 30, 2024

No description provided.

@saghul saghul mentioned this pull request May 30, 2024
7 tasks
Result of the request. < 0 means error, success otherwise. This field is always set, regardless
of the request being sync or async.

For synchronous calls, the result of each operation is this field.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth mentioning: it's also the return value of the function.

@@ -232,6 +249,8 @@ API
Equivalent to :man:`preadv(2)`. If the `offset` argument is `-1`, then
the current file offset is used and updated.

The result in `req->result` indicates the amount of bytes read, if > 0.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I realize this is nitpicking but isn't it correcter to say:

Suggested change
The result in `req->result` indicates the amount of bytes read, if > 0.
The result in `req->result` indicates the number of bytes read, if > 0.

Same on line 268. Maybe also mention that 0 means EOF.

@saghul
Copy link
Member Author

saghul commented Jun 20, 2024

Thanks for taking a look, Ben! I marked it as a draft because I need to make more changes indeed. Thanks for the suggestions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants