Add comment clarifying return value

github · Oct 8, 2015 · f6bd5b6 · f6bd5b6
1 parent 9dc2a8e
commit f6bd5b6
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/GitHub.Exports/Primitives/UriString.cs b/src/GitHub.Exports/Primitives/UriString.cs
@@ -131,7 +131,7 @@ bool ParseScpSyntax(string scpString)
         /// <summary>
         /// Attempts a best-effort to convert the remote origin to a GitHub Repository URL.
         /// </summary>
-        /// <returns></returns>
+        /// <returns>A converted uri, or the existing one if we can't convert it (which might be null)</returns>
         public Uri ToRepositoryUrl()
         {
             // we only want to process urls that represent network resources