Add docs for git oid methods #23460
Merged
Add docs for git oid methods #23460
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
ararslan
added
docs
kshyatt
reviewed
Aug 26, 2017
| """ | ||
| raw(id::GitHash) -> Vector{UInt8} | ||
|
|
||
| Obtain the raw bytes of the [`GitHash`](@ref) as a vector of length $OID_RAWSZ. |
There was a problem hiding this comment.
Should this have backticks around OID_RAWSZ?
There was a problem hiding this comment.
No, it's intended to interpolate into the docstring, since AFAICT OID_RAWSZ isn't intended to be user-facing. We do this in a few other places in this file as well.
kshyatt
reviewed
Aug 26, 2017
base/libgit2/oid.jl
Outdated
| GitHash(ptr::Ptr{UInt8}) | ||
|
|
||
| Construct a `GitHash` from a pointer to `UInt8` data containing the bytes of the | ||
| SHA-1 hash. |
There was a problem hiding this comment.
Do we want to mention what happens if you pass a NULL ptr?
|
Docs built locally and they look good, plus CI passed on Circle and FreeBSD (AppVeyor failures unrelated) on the previous commit, so I skipped CI for the most recent commit. Whoever merges this, please squash merge and remove the [ci skip] bit from the commit message. |
|
Do you want to resolve the conflict? Sorry, I think that was my fault :/ |
kshyatt
approved these changes
Aug 27, 2017
|
Yep, will do. Thanks! |
[ci skip]
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.