Skip to content

Obsolete ReferenceWrapper.Name in favor of FriendlyName #1020

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

Merged
merged 1 commit into from
Apr 15, 2015
Merged

Conversation

nulltoken
Copy link
Member

@jamill rightfully pointed at the fact that Name was maybe not explicit enough for a Branch or a Tag.

This PR is proposal to work around this by explicitly stating that this is a shortened version of the complete canonical name.

Thoughts?

@jamill
Copy link
Member

jamill commented Apr 13, 2015

To throw out another option, what about naming property FriendlyName? Otherwise, I think ShortName also captures what the property does.

@carlosmn
Copy link
Member

IIRC git also calls it the "human-friendly name". In libgit2 itself we call it "shorthand" which to me conveys more of the semantic meaning.

@nulltoken
Copy link
Member Author

Let's go with FriendlyName, then.

@nulltoken
Copy link
Member Author

Friendlier?

@nulltoken nulltoken added this to the v0.22 milestone Apr 14, 2015
/// Gets the name of this reference.
/// </summary>
[Obsolete("This property will be removed in the next release. Please use ShortName instead.")]
Copy link
Member

Choose a reason for hiding this comment

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

ShortName -> FriendlyName

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! Fixed.

@nulltoken nulltoken changed the title Obsolete ReferenceWrapper.Name in favor of ShortName Obsolete ReferenceWrapper.Name in favor of FriendlyName Apr 15, 2015
nulltoken added a commit that referenced this pull request Apr 15, 2015
Obsolete ReferenceWrapper.Name in favor of FriendlyName
@nulltoken nulltoken merged commit 420bc91 into vNext Apr 15, 2015
@nulltoken nulltoken deleted the ntk/short branch April 15, 2015 17:44
@nulltoken
Copy link
Member Author

Published as NuGet pre-release package LibGit2Sharp.0.22.0-pre20150415174523

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants