Skip to content

Resolve warnings in API docs generation #4467

New issue
New issue
Open
Open
Resolve warnings in API docs generation#4467
Labels
Priority:2Work that is important, but not critical for the releasearea-InfrastructureBuilds, CI, packaging, and repository toolingdocumentationRelated to documentation of ML.NETgreendevelopment
Milestone
ML.NET 7.0

Activity

  1. harishsk
    self-assigned this
    on Nov 12, 2019

  2. harishsk commented on Nov 13, 2019

    @harishsk
    harishsk
    on Nov 13, 2019
    Contributor

    In conversation with @natke this is the newest list of warnings.

    https://opbuildstorageprod.blob.core.windows.net/report/2019%5C11%5C12%5C1a61acc2-fbc9-ceaf-75d3-cfca51e72d2c%5CCommit%5C201911121008412598-smoke-test-preview%5Cworkflow_report.html?sv=2016-05-31&sr=b&sig=DD%2FakaoO0e4DP4V92vkRSBuZgFthSab2UuyVY07AWmU%3D&st=2019-11-13T00%3A13%3A55Z&se=2019-12-14T00%3A18%3A55Z&sp=r

  3. frank-dong-ms-zz
    added
    documentationRelated to documentation of ML.NET
    P2
    on Jan 9, 2020

  4. svick commented on Sep 2, 2026

    @svick
    svick
    on Sep 2, 2026
    Member

    Running the repository's configured ECMA-to-YAML generation locally produced:

    • 2 warnings — ECMA2Yaml_MemberNameAndSignature_NotUnique
      • Both concern RobertaPreTokenizer.Instance.
      • The generated XML contains both a static field and a static property named Instance.
    • 1 error — ECMA2Yaml_Framework_NotFound
      • TensorFlowModel.RetrainTensorFlowModel(...) refers only to old preview frameworks that are absent from the current framework index.
    • 7 informational messages
      • Assembly-version fallbacks for Microsoft.ML.SearchSpace attributes.

    The generated documentation-completeness report contains:

    Documentation field Missing Underdocumented
    Summaries 6,833 205
    Parameters 6,173 4
    Type parameters 209 0
    Return values 6,397 1

  5. rosebyte commented on Sep 8, 2026

    @rosebyte
    rosebyte
    on Sep 8, 2026
    Member

    triage: we should investigate and fix the warnings

  6. rosebyte
    added
    P3
    and removed
    P2
    on Sep 8, 2026
  7. rosebyte
    unassigned
    harishsk
    on Sep 8, 2026
  8. matouskozak
    added this to the ML.NET 7.0 milestone on Sep 8, 2026
  9. rosebyte
    added
    Priority:2Work that is important, but not critical for the release
    area-InfrastructureBuilds, CI, packaging, and repository tooling
    and removed
    P3
    on Sep 8, 2026
  10. rosebyte
    added
    greendevelopment
    on Sep 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Priority:2Work that is important, but not critical for the releasearea-InfrastructureBuilds, CI, packaging, and repository toolingdocumentationRelated to documentation of ML.NETgreendevelopment

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions