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.

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

Merged
merged 3 commits into from
Feb 8, 2017
Merged

MORE docs for libgit2 #20503

merged 3 commits into from
Feb 8, 2017

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Feb 7, 2017

No description provided.

@kshyatt kshyatt added docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module labels Feb 7, 2017
@kshyatt kshyatt requested review from simonbyrne and tkelman February 7, 2017 20:44
Copy link
Member

@KristofferC KristofferC left a 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.

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))
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thanks!

@@ -1,5 +1,10 @@
# This file is a part of Julia. License is MIT: http://julialang.org/license

"""
LibGit2.tag_list(repo::GitRepo)
Copy link
Contributor

Choose a reason for hiding this comment

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

-> Vector{String}

@kshyatt
Copy link
Contributor Author

kshyatt commented Feb 8, 2017

Passed CI, think I got all the comments, will add things to the other doc PR if not.

@kshyatt kshyatt merged commit 1b7a684 into master Feb 8, 2017
@kshyatt kshyatt deleted the ksh/docgit5 branch February 8, 2017 16:51
@tkelman
Copy link
Contributor

tkelman commented Feb 8, 2017

the statuses should describe what types they return, not clear what to expect from the current docstrings

@simonbyrne simonbyrne mentioned this pull request Feb 10, 2017
42 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants