Skip to content

Unify references to types in XML comments #3441

Open

Description

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)

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

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions