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

Fix XML doc comments (code -> c) #730

Merged
merged 1 commit into from
Sep 4, 2020
Merged

Conversation

Youssef1313
Copy link
Member

@Youssef1313 Youssef1313 commented Aug 14, 2020

Fixes MicrosoftDocs/feedback#2943

@mairaw, would <see cref="TypeName" /> be more suitable than <c>TypeName</c>?

I'm currently using <c> per your comment MicrosoftDocs/feedback#2943 (comment)

@Youssef1313
Copy link
Member Author

The doc page shows versions 1.2.0 and 1.3.2, will the change made here reflect on these versions?

@mairaw
Copy link
Member

mairaw commented Sep 1, 2020

If you use see cref, then just make sure to use the fully qualified name. But c would already fix the bad layout on docs. see cref would add the link to the API.

@Haplois Haplois merged commit 05a70b2 into microsoft:master Sep 4, 2020
@Youssef1313 Youssef1313 deleted the patch-1 branch September 4, 2020 12:09
@Haplois
Copy link
Contributor

Haplois commented Sep 4, 2020

Thank you for your contribution, @Youssef1313!

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.

References to APIs are replaced with code blocks
3 participants