Skip to content

Conversation

gewarren
Copy link
Contributor

@gewarren gewarren commented Jul 24, 2020

Suggest ignoring whitespace changes in the diff. The build is clean for these files so the xrefs are good.

Changes:

  • remove extraneous preceding characters, for example [\], Type\[\], Type\[\], Type\[\]\[\], Type\[\]\<xref:System.Reflection.Emit.TypeBuilder.DefinePInvokeMethod%2A>
  • replace %28 with (, %29 with ), %2C with , (and a few others to make xrefs more readable)

Contributes to dotnet/docs#19387.
@mairaw Thanks for letting me know about these!

@dotnet-bot dotnet-bot added this to the July 2020 milestone Jul 24, 2020
@mairaw
Copy link
Contributor

mairaw commented Jul 25, 2020

No problem! I know some of these links were not being reported on the build report but I don't see any drops on the number of warnings. Is that expected for this particular PR @gewarren?

<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This just seemed to point to itself, so I deleted it.

@gewarren gewarren requested a review from a team July 26, 2020 01:20
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM @gewarren

You can :shipit: when ready.

@gewarren
Copy link
Contributor Author

No problem! I know some of these links were not being reported on the build report but I don't see any drops on the number of warnings. Is that expected for this particular PR @gewarren?

Yes, the "xref links" weren't previously rendering as links when they were in the form [\], Type\[\], Type\[\], Type\[\]\[\], Type\[\]\<xref:System.Reflection.Emit.TypeBuilder.DefinePInvokeMethod%2A>. So they didn't generate any warnings. Now that they are links, they didn't introduce any new warnings either.

@gewarren gewarren merged commit 216891c into dotnet:master Jul 27, 2020
@gewarren gewarren deleted the bad-xrefs-4 branch July 27, 2020 17:10
@gewarren
Copy link
Contributor Author

Thanks for the reviews Maira and Bill!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants