Skip to content

Wrong XML in the example or misleading description of <param> tag #915

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

Closed
oldGlobula opened this issue Aug 20, 2023 · 1 comment · Fixed by #1004
Closed

Wrong XML in the example or misleading description of <param> tag #915

oldGlobula opened this issue Aug 20, 2023 · 1 comment · Fixed by #1004
Assignees
Milestone

Comments

@oldGlobula
Copy link

oldGlobula commented Aug 20, 2023

The tag is used to describe parameters. If such a tag is used, the documentation generator must verify that the specified parameter exists and that all parameters are described in documentation comments. If such verification fails, the documentation generator issues a warning.

This comment and D.3.9. example made me think that name attribute in <param> tag are mandatory, however, in D.5. section <param> tags do not have name attribute


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.


Associated WorkItem - 178987

@BillWagner BillWagner transferred this issue from dotnet/docs Aug 21, 2023
@BillWagner
Copy link
Member

@jskeet

The sample in D.5 should change. It should include the name attribute on the param element.

You can assign this to me and set the C# 8 milestone. It shouldn't slow down the C# 7 standardization, but it's a rather easy fix.

@jskeet jskeet added this to the C# 8.0 milestone Aug 21, 2023
@jskeet jskeet modified the milestones: C# 8.0, Pre-C# 8.0 Sep 21, 2023
@BillWagner BillWagner moved this from 🔖 Ready to 🏗 In progress in dotnet/docs November 2023 sprint Nov 22, 2023
BillWagner added a commit to BillWagner/csharpstandard that referenced this issue Nov 22, 2023
Fixes dotnet#915

In the example in D5, add the "name=" attribute on all param tags.
@BillWagner BillWagner moved this from 🏗 In progress to 👀 In review in dotnet/docs November 2023 sprint Nov 22, 2023
@jskeet jskeet closed this as completed in dfb6882 Nov 29, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in dotnet/docs November 2023 sprint Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

3 participants