Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve the Commit indexer xml doc #966

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
Closed
nulltoken opened this issue Feb 18, 2015 · 2 comments
Closed

Improve the Commit indexer xml doc #966

nulltoken opened this issue Feb 18, 2015 · 2 comments
Labels
Easy fix Up for grabs

Comments

@nulltoken
Copy link
Member

It currently states

/// <summary>
/// Gets the <see cref="TreeEntry"/> pointed at by the <paramref name="relativePath"/> in the <see cref="Tree"/>.
/// </summary>
/// <param name="relativePath">The relative path to the <see cref="TreeEntry"/> from the <see cref="Commit"/> working directory.</param>
/// <returns><c>null</c> if nothing has been found, the <see cref="TreeEntry"/> otherwise.</returns>
  • relativePath usage is misleading. Maybe just path?
  • working directory makes no sense from a Commit standpoint. Maybe just root?
@carlosmn
Copy link
Member

Naming it "path" and changing the comment to something like

Path to the TreeEntry from the root tree

or

Path to the TreeEntry from the tree in this commit

should cover both situations ("root tree" and "tree in this commit" are equivalent concepts).

@nulltoken
Copy link
Member Author

Path to the TreeEntry from the tree in this commit

👍

@Vogel612 Vogel612 mentioned this issue Sep 8, 2015
Merged
golsby pushed a commit to golsby/libgit2sharp that referenced this issue Nov 12, 2015
@Vogel612 @golsby
Adjusted Commit indexer xml doc see and fixes libgit2#966
35d45cc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Easy fix Up for grabs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nulltoken @carlosmn