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 more comprehensive docstrings to Base.LibGit2 #18810

Closed
ararslan opened this issue Oct 6, 2016 · 9 comments
Closed

Add more comprehensive docstrings to Base.LibGit2 #18810

ararslan opened this issue Oct 6, 2016 · 9 comments
Labels
docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia Hacktoberfest Good for Hacktoberfest participants libgit2 The libgit2 library or the LibGit2 stdlib module

Comments

@ararslan
Copy link
Member

ararslan commented Oct 6, 2016

Perhaps another good introductory issue and/or candidate for Hacktoberfest.

Background

LibGit2 is a submodule of Base that contains bindings to the libgit2 C library. It's used extensively by the package manager as well as some external libraries, such as the package development toolkit. As I understand it, much of the existing functionality in Base.LibGit2 came from Jake Bolewski's now-unmaintained LibGit2.jl package. Prior to utilizing libgit2, Julia included a wrapper for command line Git.

What's needed

Currently there aren't very many docstrings in the LibGit2 code, and the ones that are there could be more detailed. I think it would be a worthwhile effort to more thoroughly document the Base.LibGit2 functionality and usage.

The files in question are located in the base/libgit2 directory.
@tkelman tkelman added docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module labels Oct 6, 2016
@kshyatt kshyatt added Hacktoberfest Good for Hacktoberfest participants good first issue Indicates a good issue for first-time contributors to Julia labels Oct 6, 2016
@simonbyrne simonbyrne mentioned this issue Jan 4, 2017
Open
42 tasks
@KristofferC
Copy link
Sponsor Member

Can this be considered done enough to not need a separate issue?

@tkelman
Copy link
Contributor

tkelman commented Jun 25, 2017

many of the internal functions are still undocumented

@kshyatt
Copy link
Contributor

kshyatt commented Jun 25, 2017

@KristofferC no :(

@kshyatt
Copy link
Contributor

kshyatt commented Jun 25, 2017 •
edited by omus
Loading

Here's a list of functions/types which still need docstrings:

@kshyatt kshyatt mentioned this issue Jun 25, 2017
Merged
@ararslan
Copy link
Member Author

Thanks so much for enumerating those, @kshyatt! It's too bad I didn't think to advertise this for the JuliaCon hackathon.

@kshyatt
Copy link
Contributor

kshyatt commented Jun 26, 2017

@omus since you did so much awesome work refactoring the SSH credentials stuff I was wondering if you wanted to take a run at documenting all those functions? I think this stuff is very important to get right (since it's security related) and it's finicky enough I don't want to make things worse by guessing.

@omus
Copy link
Member

omus commented Jun 26, 2017

@kshyatt sure I'll try to document those when I have some spare cycles

@omus
Copy link
Member

omus commented Sep 14, 2017

LibGit2.checkused! was removed by #23575 and LibGit2.get_creds! will be removed by #23711. I removed most of the LibGit2.reset! in #23575 methods but there are a few left that need some updating.

@ViralBShah
Copy link
Member

Can we close this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia Hacktoberfest Good for Hacktoberfest participants libgit2 The libgit2 library or the LibGit2 stdlib module
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@StefanKarpinski @ViralBShah @kshyatt @KristofferC @omus @tkelman @ararslan