Skip to content

Unify references to types in XML comments #3441

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

Open
michael-hawker opened this issue Aug 18, 2020 · 2 comments
Open

Unify references to types in XML comments #3441

michael-hawker opened this issue Aug 18, 2020 · 2 comments
Labels
documentation 📃 good first issue Issues identified as good for first-time contributors Hacktoberfest Hacktoberfest is a month-long celebration of open source software help wanted Issues identified as good community contribution opportunities improvements ✨ maintenance ⚙️
Milestone

Comments

@michael-hawker
Copy link
Member

Based on a comment in #3434, we should do a better job of consistency in our XML comments.

We should do an audit and then add guidance in our contributor docs.

Side note - we should unify the way we display langwords in XML comments throughout the repository. Right now we have some displayed as plain text, some as inline markdown code (true), some as XML code blocks (<c>true</c>), some as XML langwords (langword="true").

Originally posted by @Sergio0694 in #3434 (comment)

@ghost ghost added the needs triage 🔍 label Aug 18, 2020
@ghost
Copy link

ghost commented Aug 18, 2020

Hello michael-hawker, thank you for opening an issue with us!

I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback 🙌

@michael-hawker michael-hawker added documentation 📃 good first issue Issues identified as good for first-time contributors help wanted Issues identified as good community contribution opportunities improvements ✨ maintenance ⚙️ and removed needs triage 🔍 labels Aug 18, 2020
@michael-hawker michael-hawker added this to the 7.0 milestone Aug 18, 2020
@michael-hawker
Copy link
Member Author

Another example: #3434 (comment)

Side note, ideally all these type references should be proper XML refs, for consistency and also to allow devs to just CTRL + click into any of these to read more about them through the VS jump to definition feature.

@Kyaa-dost Kyaa-dost modified the milestones: 7.0, 7.1 Dec 8, 2020
@michael-hawker michael-hawker modified the milestones: 7.1, 7.2/8.0? Aug 31, 2021
@michael-hawker michael-hawker added the Hacktoberfest Hacktoberfest is a month-long celebration of open source software label Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📃 good first issue Issues identified as good for first-time contributors Hacktoberfest Hacktoberfest is a month-long celebration of open source software help wanted Issues identified as good community contribution opportunities improvements ✨ maintenance ⚙️
Projects
None yet
Development

No branches or pull requests

2 participants