You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
When looking at the XML documentation for an API that seems to have been generated from .Net API reference, such as netstandard.xml, I can see docs-relative URLs such as ~/docs/standard/base-types/regular-expression-options.md, while I think it should point to the live URL for the article: https://docs.microsoft.com/dotnet/standard/base-types/regular-expression-options.
Specifically, netstandard.xml (from version 2.0.3 of the NETStandard.Library package) contains (reformatted):
<member name="F:System.Text.RegularExpressions.RegexOptions.Singleline">
<summary>
Specifies single-line mode. Changes the meaning of the dot (.) so it matches every
character (instead of every character except \n). For more information, see the
"Single-line Mode" section in the
<see cref="~/docs/standard/base-types/regular-expression-options.md">
Regular Expression Options</see> topic.</summary>
<returns></returns>
</member>
Notice how the <see cref> contains a URL that does not make sense outside of the docs repo.
This content seems to come from this line in dotnet/dotnet-api-docs.
Expected behavior
XML documentation contains links to live versions of linked articles.
Note that while there doesn't seem to be spec-approved way provide HTTP links in XML documentation, ReSharper/Rider seems to accept <a href>, and there is a proposal to adopt <see href>: dotnet/csharplang#1764, which is also used by Sandcastle.
Screenshots
This is how the XML documentation is currently presented in Rider, where the link is not very useful:
Document Details
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
ID: bf9b6611-d08f-2fe9-216b-e0658d7f1553
Version Independent ID: 3d3be892-b9b5-ca0b-1193-9fa49716decb
I've checked what's being produced by our latest IntelliSense builds and the link is no longer there (this has been the behavior of how we render links on IntelliSense):
<membername="F:System.Text.RegularExpressions.RegexOptions.Singleline">
<summary>Specifies single-line mode. Changes the meaning of the dot (.) so it matches every character (instead of every character except \n). For more information, see the "Single-line Mode" section in the Regular Expression Options topic.</summary>
</member>
We'd now need to update the .NET Standard package with the latest version of our IntelliSense files. @ahsonkhan@safern can you guys help with this?
This issue was created by @svick from MicrosoftDocs/feedback#659
Describe the bug
When looking at the XML documentation for an API that seems to have been generated from .Net API reference, such as netstandard.xml, I can see docs-relative URLs such as
~/docs/standard/base-types/regular-expression-options.md
, while I think it should point to the live URL for the article: https://docs.microsoft.com/dotnet/standard/base-types/regular-expression-options.Specifically, netstandard.xml (from version 2.0.3 of the NETStandard.Library package) contains (reformatted):
<member name="F:System.Text.RegularExpressions.RegexOptions.Singleline">
<summary>
Specifies single-line mode. Changes the meaning of the dot (.) so it matches every
character (instead of every character except \n). For more information, see the
"Single-line Mode" section in the
<see cref="~/docs/standard/base-types/regular-expression-options.md">
Regular Expression Options</see> topic.</summary>
<returns></returns>
</member>
Notice how the <see cref> contains a URL that does not make sense outside of the docs repo.
This content seems to come from this line in dotnet/dotnet-api-docs.
Expected behavior
XML documentation contains links to live versions of linked articles.
Note that while there doesn't seem to be spec-approved way provide HTTP links in XML documentation, ReSharper/Rider seems to accept <a href>, and there is a proposal to adopt <see href>: dotnet/csharplang#1764, which is also used by Sandcastle.
Screenshots
This is how the XML documentation is currently presented in Rider, where the link is not very useful:
Document Details
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The text was updated successfully, but these errors were encountered: