-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
MORE docs for libgit2 #20503
MORE docs for libgit2 #20503
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be useful to be a bit more explicit of what the return types of the functions are.
base/libgit2/tag.jl
Outdated
function tag_delete(repo::GitRepo, tag::AbstractString) | ||
@check ccall((:git_tag_delete, :libgit2), Cint, | ||
(Ptr{Void}, Cstring, ), repo.ptr, tag) | ||
end | ||
|
||
""" | ||
LibGit2.tag_create(repo::GitRepo, tag::AbstractString, commit, msg::AbstractString="", force::Bool=false, sig::Signature=Signature(repo)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
msg
and on are keyword args
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed, thanks!
base/libgit2/tag.jl
Outdated
@@ -1,5 +1,10 @@ | |||
# This file is a part of Julia. License is MIT: http://julialang.org/license | |||
|
|||
""" | |||
LibGit2.tag_list(repo::GitRepo) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-> Vector{String}
Passed CI, think I got all the comments, will add things to the other doc PR if not. |
the statuses should describe what types they return, not clear what to expect from the current docstrings |
No description provided.