Skip to content

Fill and review API documentation#179

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
automation/write-api-docs
Open

Fill and review API documentation#179
github-actions[bot] wants to merge 1 commit into
mainfrom
automation/write-api-docs

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Fills the 4 remaining To be added. placeholders that surfaced after this run's stub regeneration, all on span-based overloads that mirror an existing string overload with fully-written docs.

What was filled (3 files, 4 members)

  • SkiaSharpAPI/SkiaSharp/SKColor.xmlSKColor.Parse(ReadOnlySpan<char>) and SKColor.TryParse(ReadOnlySpan<char>, out SKColor) — mirrored the string overloads (same accepted formats, same return semantics).
  • SkiaSharpAPI/SkiaSharp/SKFourByteTag.xmlSKFourByteTag.Parse(ReadOnlySpan<char>) — mirrored the string overload (up-to-4 ASCII chars, right-padded with spaces, longer truncated).
  • SkiaSharpAPI/HarfBuzzSharp/Tag.xmlTag.Parse(ReadOnlySpan<char>) — mirrored the ISO 15924 string overload.

What was reviewed

  • The three touched type files (factual / examples / quality passes per references/reviewing.md). New prose is a direct restatement of the sibling string-overload docs already accepted in the repo, so no factual drift is introduced.
  • Deterministic gate dotnet cake --target=docs-format-docs was run before and after; second run reports 0/5026 (0.0%) missing members and 0 finding(s), 0 error(s) across 406 type files.

Findings summary

Severity Count
CRITICAL 0
IMPORTANT 0
MINOR 0

Machine block:

FINDING | (none)

No obsolete-member usage was introduced (no code examples added in this pass). Nothing deferred.

Fixed vs deferred

  • Fixed: all 4 placeholders reported by the deterministic gate.
  • Deferred: none.

Generated by Auto API Docs Writer · ● 3.4M ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit db26459:

⚠️ Validation status: warnings

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp/SKColor.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml ⚠️Warning Details
SkiaSharpAPI/HarfBuzzSharp/Tag.xml ✅Succeeded

SkiaSharpAPI/SkiaSharp/SKColor.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.SKColor's moniker skiasharp can't match any assembly.

SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.SKFourByteTag's moniker skiasharp can't match any assembly.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

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.

0 participants