Add comment clarifying return value

shana · shana · commit f6bd5b6b835f · 2015-10-08T20:25:23.000+02:00
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

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ bool ParseScpSyntax(string scpString)`
`131`	`131`	`/// <summary>`
`132`	`132`	`/// Attempts a best-effort to convert the remote origin to a GitHub Repository URL.`
`133`	`133`	`/// </summary>`
`134`		`- /// <returns></returns>`
	`134`	`+ /// <returns>A converted uri, or the existing one if we can't convert it (which might be null)</returns>`
`135`	`135`	`public Uri ToRepositoryUrl()`
`136`	`136`	`{`
`137`	`137`	`// we only want to process urls that represent network resources`