Skip to content
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

Remarks section of enum members doc comment doesn't show in API reference #23950

Closed
Youssef1313 opened this issue Apr 27, 2021 · 7 comments
Closed

Comments

@Youssef1313
Copy link
Member

This is not specific to LanguageVersion enum. Any enum with <remarks> on a member won't show in the API reference.


Document Details

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

@BillWagner
Copy link
Member

Ping @joelmartinez

Where should we route this?

@joelmartinez
Copy link

🤔 hmm ... this is because we currently treat enums differently than other types, where each member doesn't have an individual page in which we would show remarks; we just list all the enums and their summary on one page. Brainstorming a bit, we would probably either have to expand that out so that each member of the enum has its own page, or maybe do something where the remarks for each field are hidden by default, and you can expand them on-demand.

You probably want to work with PMs (ie. @mimisasouvanh and @rloutlaw) to design and prioritize this feature request :)

/cc @TianqiZhang @wh-alice

@gewarren
Copy link
Contributor

This is a known issue and we've already met once on the proposed design - https://dev.azure.com/ceapex/Engineering/_workitems/edit/390259.

@gewarren
Copy link
Contributor

We also currently have a build warning to let you know that the remarks will be ignored.

@Youssef1313
Copy link
Member Author

@gewarren Should I close if it's already tracked internally?

@gewarren
Copy link
Contributor

Yes, I'll close this, but I've added a link to this issue in the internal tracking item. Thanks @Youssef1313 .

@gewarren
Copy link
Contributor

gewarren commented Jun 5, 2023

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

No branches or pull requests

6 participants