Skip to content

Xml doc bugfixes #1004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 29, 2023
Merged

Xml doc bugfixes #1004

merged 5 commits into from
Nov 29, 2023

Conversation

BillWagner
Copy link
Member

@BillWagner BillWagner commented Nov 22, 2023

Fixes three issues:

Fixes #771. The string IDs for methods that are explicit implementations of members of generic interfaces have the < and > characters replaced with { and }.
Fixes #772: single dimension arrays don't specify the lower bound in their string ids. Instead of [0] its [].
Fixes #915: The example didn't include the "name=" attributes on parameters.

The fixes are in three distinct commits to make it easier to review.

Fixes dotnet#771

Add instances where the `<` and `>` characters are replaced by `{` and `}` in the string IDs.
Fixes dotnet#772

Single dimension arrays are encoded as "[]" rather than "[0]".
Fixes dotnet#915

In the example in D5, add the "name=" attribute on all param tags.
@BillWagner BillWagner added the meeting: discuss This issue should be discussed at the next TC49-TG2 meeting label Nov 22, 2023
I thought about removing the `<c>` tags in my previous commit, but I was waiting for other opinions, and wanted to verify that there was at least one tag like that still in the example.
Copy link
Contributor

@jskeet jskeet left a comment

Choose a reason for hiding this comment

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

Hooray, thanks :)

@KalleOlaviNiemitalo
Copy link
Contributor

KalleOlaviNiemitalo commented Nov 22, 2023

Now I wonder how the name of a type is formatted in these if it involves an extern alias. Particularly if class C has conversion operators to both X::T and Y::T, where X and Y are extern aliases, and T is the same identifier in both but means different types.

@KalleOlaviNiemitalo
Copy link
Contributor

The extern alias thing is a bit related to dotnet/docfx#2620

@jskeet jskeet merged commit 12bf7ec into dotnet:draft-v8 Nov 29, 2023
@BillWagner BillWagner deleted the xml-doc-bugfixes branch November 29, 2023 21:16
@jskeet
Copy link
Contributor

jskeet commented Nov 29, 2023

Now I wonder how the name of a type is formatted in these if it involves an extern alias.

Meeting note: We're not sure either. Please feel free to experiment and either raise a PR or an issue with your findings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meeting: discuss This issue should be discussed at the next TC49-TG2 meeting
Projects
None yet
6 participants