Skip to content

Commit f8302e2

Browse files
committed
Improve RepositoryExtensions documentation
1 parent 872a4ee commit f8302e2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

LibGit2Sharp/RepositoryExtensions.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ public static Tag ApplyTag(this IRepository repository, string tagName)
4343
}
4444

4545
/// <summary>
46-
/// Creates a lightweight tag with the specified name. This tag will point at the <paramref name = "target" />.
46+
/// Creates a lightweight tag with the specified name. This tag will point at the <paramref name = "objectish" />.
4747
/// </summary>
4848
/// <param name = "repository">The <see cref = "Repository" /> being worked with.</param>
4949
/// <param name = "tagName">The name of the tag to create.</param>
50-
/// <param name = "target">The canonical reference name or sha which should be pointed at by the Tag.</param>
51-
public static Tag ApplyTag(this IRepository repository, string tagName, string target)
50+
/// <param name = "objectish">The revparse spec for the target object.</param>
51+
public static Tag ApplyTag(this IRepository repository, string tagName, string objectish)
5252
{
53-
return repository.Tags.Add(tagName, target);
53+
return repository.Tags.Add(tagName, objectish);
5454
}
5555

5656
/// <summary>
@@ -66,16 +66,16 @@ public static Tag ApplyTag(this IRepository repository, string tagName, Signatur
6666
}
6767

6868
/// <summary>
69-
/// Creates an annotated tag with the specified name. This tag will point at the <paramref name = "target" />.
69+
/// Creates an annotated tag with the specified name. This tag will point at the <paramref name = "objectish" />.
7070
/// </summary>
7171
/// <param name = "repository">The <see cref = "Repository" /> being worked with.</param>
7272
/// <param name = "tagName">The name of the tag to create.</param>
73-
/// <param name = "target">The canonical reference name or sha which should be pointed at by the Tag.</param>
73+
/// <param name = "objectish">The revparse spec for the target object.</param>
7474
/// <param name = "tagger">The identity of the creator of this tag.</param>
7575
/// <param name = "message">The annotation message.</param>
76-
public static Tag ApplyTag(this IRepository repository, string tagName, string target, Signature tagger, string message)
76+
public static Tag ApplyTag(this IRepository repository, string tagName, string objectish, Signature tagger, string message)
7777
{
78-
return repository.Tags.Add(tagName, target, tagger, message);
78+
return repository.Tags.Add(tagName, objectish, tagger, message);
7979
}
8080

8181
/// <summary>
@@ -104,10 +104,10 @@ public static Branch CreateBranch(this IRepository repository, string branchName
104104
/// </summary>
105105
/// <param name = "repository">The <see cref = "Repository" /> being worked with.</param>
106106
/// <param name = "branchName">The name of the branch to create.</param>
107-
/// <param name = "target">The canonical reference name or sha which should be pointed at by the Branch.</param>
108-
public static Branch CreateBranch(this IRepository repository, string branchName, string target)
107+
/// <param name = "commitish">The revparse spec for the target commit.</param>
108+
public static Branch CreateBranch(this IRepository repository, string branchName, string commitish)
109109
{
110-
return repository.Branches.Add(branchName, target);
110+
return repository.Branches.Add(branchName, commitish);
111111
}
112112

113113
/// <summary>

0 commit comments

Comments
 (0)