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 the diff.jl methods #22553

Merged
merged 2 commits into from
Jun 27, 2017
Merged

Add docs for the diff.jl methods #22553

merged 2 commits into from
Jun 27, 2017

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Jun 26, 2017

If you think it would be helpful, I can try to generate some examples for the two diff_tree methods.

@kshyatt kshyatt added docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module labels Jun 26, 2017
@kshyatt kshyatt requested review from tkelman and ararslan June 26, 2017 17:53
@kshyatt kshyatt mentioned this pull request Jun 26, 2017
Closed
ararslan
ararslan reviewed Jun 26, 2017
View reviewed changes
base/libgit2/diff.jl Outdated

Generates a [`GitDiff`](@ref) between `tree` (which will be used for the "old"
Copy link
Member

Choose a reason for hiding this comment

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

"Generate" perhaps?

ararslan
ararslan reviewed Jun 26, 2017
View reviewed changes
base/libgit2/diff.jl Outdated
"""
GitDiffStats(diff::GitDiff)

Get the diff statistics from the `GitDiff` `diff`. This object records a summary
Copy link
Member

Choose a reason for hiding this comment

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

Maybe @ref the GitDiff?

@kshyatt
Copy link
Contributor Author

kshyatt commented Jun 26, 2017

make check-whitespace passes

@tkelman
Copy link
Contributor

tkelman commented Jun 26, 2017

should also be checking make docs works

@kshyatt
Copy link
Contributor Author

kshyatt commented Jun 26, 2017

make docs works

@kshyatt
Copy link
Contributor Author

kshyatt commented Jun 27, 2017

Bump - ok to go?

@kshyatt kshyatt merged commit 9f6ec29 into master Jun 27, 2017
@kshyatt kshyatt deleted the ksh/docdiff branch June 27, 2017 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ararslan ararslan ararslan approved these changes

@tkelman tkelman Awaiting requested review from tkelman

Assignees
No one assigned
Labels
docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kshyatt @tkelman @ararslan