Skip to content

Update API docs to conform with doc standards #22893

Description

@AbandonedRickshaw

It's just a generated stub, with no references to methods, properties, etc.


Document Details

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

Activity

  1. roji commented on Oct 3, 2020

    @roji
    Member

    This property has already been documented for 5.0 (along with many others), but the updated docs will only be visible when 5.0 is released.

  2. smitpatel commented on Oct 3, 2020

    @smitpatel
    Contributor

    Missing value tags in XML docs.

  3. roji commented on Oct 3, 2020

    @roji
    Member

    We hardly have value tags anywhere in our docs (seems like 12 occurrences in the core project, I've personally never understood why those are needed in addition to the summary). If we think it's important, maybe open a separate issue for a larger effort?

  4. smitpatel commented on Oct 3, 2020

    @smitpatel
    Contributor

    We discussed this issue in triage briefly and determined that we should do something to avoid empty "Property Value" on the doc page. Adding value tag resolves that. The task item in triage was to figure out API docs guidelines from docs team, which I sent in an email. We will discuss this in next meeting.

  5. changed the title [-]Completely useless[/-] [+]Update API docs to conform with doc standards[/+] on Oct 5, 2020
  6. added this to the MQ milestone on Oct 5, 2020
  7. self-assigned this
    on Oct 5, 2020
  8. removed their assignment
    on Dec 2, 2023
  9. added theissue type on Jun 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions