Update documentation on InvalidSpecificationException

jamill · nulltoken · commit 24446f5e2b45 · 2015-01-21T12:20:20.000+01:00
Update documentation on InvalidSpecificationException to better reflect
the current meaning of this exception.
diff --git a/LibGit2Sharp/InvalidSpecificationException.cs b/LibGit2Sharp/InvalidSpecificationException.cs
@@ -5,7 +5,10 @@
 namespace LibGit2Sharp
 {
     /// <summary>
-    /// The exception that is thrown when the provided specification is syntactically incorrect.
+    /// The exception that is thrown when a provided specification is bad. This
+    /// can happen if the provided specification is syntactically incorrect, or
+    /// if the spec refers to an object of an incorrect type (e.g. asking to
+    /// create a branch from a blob, or peeling a blob to a commit).
     /// </summary>
     [Serializable]
     public class InvalidSpecificationException : LibGit2SharpException
