Improve IUrlHelper and related doc comments
#4948
Conversation
dougbu
commented
Jul 1, 2016
dougbu
commented
- Potential clarity problems with IUrlHelper #4245, Url.RouteUrl XML Documentation is incorrect. #4507
| /// </summary> | ||
| /// <param name="actionContext">The context object for the generated URLs for an action method.</param> | ||
| /// <returns>The fully qualified or absolute URL to an action method.</returns> | ||
| /// <returns>The URL with an absolute path for an action method.</returns> |
There was a problem hiding this comment.
I think that this is an overall improvement in the clarity. My one suggestion here would be to not repeat the part about a URL with an absolute path, and tweak the summary to be like:
Generates an absolute URL if <see cref="UrlActionContext.Protocol"/> and <see cref="UrlActionContext.Host"/> are non-<c>null</c>, otherwise generates a URL with an absolute path.
There was a problem hiding this comment.
I'm struggling with the "otherwise" nature of your suggestion. URLs with absolute paths are a strict subset of absolute URLs. Will play w/ the wording a bit more ...
|
⌚ I have a few suggestions, but overall looks like a big improvement 👍 |
|
🆙📅 though I haven't done the "reword |
|
Rcv'd offline |
from
