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.

Sign up for GitHub

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

Jump to bottom

Add docs for blob.jl #22555

Merged
merged 7 commits into from
Jul 8, 2017
Merged

Add docs for blob.jl #22555

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
87ad13e
Add docs for blob.jl
kshyatt Jun 26, 2017
4cea271
[ci skip] update wording
kshyatt Jun 26, 2017
2d298d3
[ci skip] fix wording, add a reference
kshyatt Jun 26, 2017
7ac475f
[ci skip] fix wording
kshyatt Jun 27, 2017
569cb2f
[ci skip] fix wording
kshyatt Jun 27, 2017
8d12869
[ci skip] fix typo
kshyatt Jun 28, 2017
2562bba
[ci skip] Signature tweak
kshyatt Jul 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions base/libgit2/blob.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ end

Fetch the *raw* contents of the [`GitBlob`](@ref) `blob`. This is a read-only
Copy link
Contributor

Choose a reason for hiding this comment

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

what does read only mean here? you can always write to julia arrays

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did the revised wording make this clearer?

`Array` containing the contents of the blob, which may be binary or may be ASCII
`String` data.
`String` data. `rawcontent` will allow the user to load the raw binary data into
the output `Array` and will not check to ensure it is a valid `String`, so errors
may occur if the result is passed to functions which expect valid `String` data.
Copy link
Contributor

Choose a reason for hiding this comment

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

is the result an array or a string? if this is type stable and always array, then you won't be passing it directly to most String functions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Counterpoint: just a few lines below, s = String(rawcontent(blob)) 😛

Copy link
Contributor

Choose a reason for hiding this comment

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

the constructor yes, but not things that expect a String


See also [`content`](@ref).
See also [`content`](@ref), which *will* throw an error the content of the `blob`
Copy link
Contributor

Choose a reason for hiding this comment

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

throw an error if the content

is binary and not valid ASCII.
Copy link
Contributor

Choose a reason for hiding this comment

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

does it error on unicode?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually I think it shouldn't, the libgit2 docs only refer to "printable characters"

"""
function rawcontent(blob::GitBlob)
ptr = ccall((:git_blob_rawcontent, :libgit2), Ptr{UInt8}, (Ptr{Void},), blob.ptr)
Expand Down