-
-
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
Implement, test, doc git descriptions for things #20885
Conversation
base/libgit2/repository.jl
Outdated
|
||
* `options::DescribeOptions=DescribeOptions()` | ||
|
||
Equivalent to `git-describe <commitish>`. |
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 don't think there should be a hyphen between git
and describe
; git describe
is the CLI AFAICT
It might be nice to have the description interface be simply |
I did it this way because it's a type and otherwise it lacks a constructor. |
|
test/libgit2.jl
Outdated
@@ -354,6 +354,7 @@ mktempdir() do dir | |||
@test contains(showstr[4], "SHA:") | |||
@test showstr[5] == "Message:" | |||
@test showstr[6] == commit_msg1 | |||
|
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.
don't add empty lines as the first or last thing in a block
we're in feature freeze, not the best time to be wrapping new api's |
@staticfloat asked for it, we can wait until we're out of FF to merge if you want. |
@tkelman I've rebased this against master. We're off feature freeze, right? |
And bumping again. Can someone ( @ararslan ? @simonbyrne ? ) please review this? |
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 made the small doc change suggested by @ararslan, LGTM once CI is done.
base/libgit2/repository.jl
Outdated
|
||
* `options::DescribeOptions=DescribeOptions()` | ||
|
||
Equivalent to `git-describe`. |
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.
does the same apply here?
Now you can ask for detailed descriptions of a repo's workdir or a commit-like object within it. cc @staticfloat.