uv_buf_t: Document member fields. #307
Closed
Conversation
This file contains 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
|
Thanks Corey! Can you pleas use the "..c:member" syntax instead? Look at any other type, that's how we've documented structure members. |
|
I actually copied the format used by all other structures in misc.rst! Anyways I've just updated this as requested. |
|
LGTM, thanks! Can you please squash the commit messages into one? Also, please adjust the commit message to something like "doc: document uv_buf_t members". |
It is sometimes useful to read the base pointer or length stored in a uv_buf_t. This change documents those fields.
|
Squashed, commit msg first line updated. |
saghul
pushed a commit
that referenced
this pull request
Apr 7, 2015
PR-URL: #307 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
|
Thanks Corey! Landed in e2e218b |
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.
It is sometimes useful to read the base pointer or length stored in a uv_buf_t. This change documents those fields.
This is a followup to issue #305. I'm unsure if it's important to document the difference with Windows since it seems to have no effect on source compatibility.