Finish docs for GitTree #23451
Merged
Finish docs for GitTree #23451
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kshyatt
added
docs
Never! |
ararslan
reviewed
Aug 25, 2017
base/libgit2/tree.jl
Outdated
| @@ -1,11 +1,16 @@ | |||
| # This file is a part of Julia. License is MIT: https://julialang.org/license | |||
|
|
|||
| """ | |||
| Traverse the entries in a tree and its subtrees in post or pre order. | |||
| treewalk(f::Function, tree::GitTree, payload=Any[], post::Bool = false) | |||
There was a problem hiding this comment.
Inconsistent spacing around the =
base/libgit2/tree.jl
Outdated
| Traverse the entries in a tree and its subtrees in post or pre order. | ||
| treewalk(f::Function, tree::GitTree, payload=Any[], post::Bool = false) | ||
|
|
||
| Traverse the entries in `tree` and its subtrees in post or pre order. |
There was a problem hiding this comment.
What does "post or pre order" mean? Might be good to spell that out in layman's terms.
| """ | ||
| filemode(te::GitTreeEntry) -> Cint | ||
|
|
||
| Return the UNIX filemode of the object on disk to which `te` refers as an integer. |
There was a problem hiding this comment.
What behavior does this have on Windows?
There was a problem hiding this comment.
Do we have a test for it that runs on Windows?
There was a problem hiding this comment.
Yeah, I think we do. It's here. I think that's still the UNIX filemode?
There was a problem hiding this comment.
I guess so. I didn't think UNIX filemodes were applicable to Windows, but ¯\_(ツ)_/¯
|
Is this good to go? |
ararslan
approved these changes
Aug 29, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Someday @ararslan will demand I stop doccing things...