Update docs #4426
Draft
Update docs #4426
+41
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bnoordhuis
approved these changes
Jun 20, 2024
| 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. |
There was a problem hiding this comment.
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. | |||
There was a problem hiding this comment.
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.
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.