fixup! Introduce repo.Describe()

Author: nulltoken

LibGit2Sharp/DescribeOptions.cs

@@ -24,7 +24,7 @@ public DescribeOptions()
         }
 
         /// <summary>
-        /// The kind of references that will be elligible as reference points.
+        /// The kind of references that will be eligible as reference points.
         /// </summary>
         public DescribeStrategy Strategy { get; set; }
 

LibGit2Sharp/IRepository.cs

@@ -366,6 +366,22 @@ public interface IRepository : IDisposable
         /// <returns>A <see cref="RepositoryStatus"/> holding the state of all the files.</returns>
         RepositoryStatus RetrieveStatus(StatusOptions options);
 
+        /// <summary>
+        /// Finds the most recent annotated tag that is reachable from a commit.
+        /// <para>
+        ///   If the tag points to the commit, then only the tag is shown. Otherwise,
+        ///   it suffixes the tag name with the number of additional commits on top
+        ///   of the tagged object and the abbreviated object name of the most recent commit.
+        /// </para>
+        /// <para>
+        ///   Optionally, the <paramref name="options"/> parameter allow to tweak the
+        ///   search strategy (considering lightweith tags, or even branches as reference points)
+        ///   and the formatting of the returned identifier.
+        /// </para>
+        /// </summary>
+        /// <param name="commit">The commit to be described.</param>
+        /// <param name="options">Determines how the commit will be described.</param>
+        /// <returns>A descriptive identifier for the commit based on the nearest annotated tag.</returns>
         string Describe(Commit commit, DescribeOptions options);
     }
 }

LibGit2Sharp/Repository.cs

@@ -1891,6 +1891,22 @@ private IEnumerable<string> RemoveStagedItems(IEnumerable<string> paths, bool re
             return removed;
         }
 
+        /// <summary>
+        /// Finds the most recent annotated tag that is reachable from a commit.
+        /// <para>
+        ///   If the tag points to the commit, then only the tag is shown. Otherwise,
+        ///   it suffixes the tag name with the number of additional commits on top
+        ///   of the tagged object and the abbreviated object name of the most recent commit.
+        /// </para>
+        /// <para>
+        ///   Optionally, the <paramref name="options"/> parameter allow to tweak the
+        ///   search strategy (considering lightweith tags, or even branches as reference points)
+        ///   and the formatting of the returned identifier.
+        /// </para>
+        /// </summary>
+        /// <param name="commit">The commit to be described.</param>
+        /// <param name="options">Determines how the commit will be described.</param>
+        /// <returns>A descriptive identifier for the commit based on the nearest annotated tag.</returns>
         public string Describe(Commit commit, DescribeOptions options)
         {
             Ensure.ArgumentNotNull(commit, "commit");

LibGit2Sharp/RepositoryExtensions.cs

@@ -749,7 +749,7 @@ public static RepositoryStatus RetrieveStatus(this IRepository repository)
         /// </summary>
         /// <param name="repository">The <see cref="IRepository"/> being worked with.</param>
         /// <param name="commit">The commit to be described.</param>
-        /// <returns>A formatted string providing </returns>
+        /// <returns>A descriptive identifier for the commit based on the nearest annotated tag.</returns>
         public static string Describe(this IRepository repository, Commit commit)
         {
             return repository.Describe(commit, new DescribeOptions());