Skip to content

docs(release): API review notes for the 1.0 sign-off - #297

Open
michaelstonis wants to merge 2 commits into
mainfrom
docs/112-api-review
Open

michaelstonis wants to merge 2 commits into
mainfrom
docs/112-api-review

Conversation

@michaelstonis

Copy link
Copy Markdown
Contributor

Refs #112 (stays open until the freeze at the 1.0.0 tag).

Adds docs/release/api-review-1.0.md, a line-by-line review of the public surface of all four packages: 25 findings (1 must-fix, 11 should, 13 nits), each with file:line, the proposed change and whether it is breaking, plus a section on each open-before-1.0.0 decision with a recommendation, and the steps for the freeze at the tag.

No public API changes and no Unshipped to Shipped move. The only code changes are doc comments: <exception cref="ArgumentNullException"> on KumikoScroller and KumikoAnnouncements, and two "cancelled" to "canceled" fixes.

Must-fix before the freeze: eng/update-public-api.sh re-adds the Uno heads' generated GlobalStaticResources lines to Unshipped (RS0025 once they are in Shipped) and deletes a head's PublicAPI.Shipped.txt when its Unshipped file comes out empty.

Decisions for the maintainer (recommendations):

  • D1 hex color order: keep #AARRGGBB.
  • D2 editor factories: consolidate on CellEditorContext and remove CustomEditorFactory while still in preview.
  • D3 Android RenderMode = Auto: keep Hardware, gate the release on one physical low-end device pass.
  • D4 HarfBuzz: keep it, after measuring the real size increase and checking Uno text with HarfBuzzSharp 14.

Builds: Core, SkiaSharp, MAUI and Uno 0 warnings; DocsIdentifiers and dotnet format clean.

…koAnnouncements (#112)

Add the missing <exception> docs to the seven KumikoScroller methods and
the six KumikoAnnouncements methods that already throw it, and use
American spelling in two summaries. No signature changes.
Second pass over every public member of KumikoUI.Core, .SkiaSharp,
.Maui and .Uno as shipped in 1.0.0-preview.1: findings by package with
severity and whether each change is breaking, the evidence, options and
a recommendation for the four open decisions (hex color order, editor
factory shapes, Android Auto render mode, HarfBuzz dependency), and the
updated steps for the freeze at the 1.0.0 tag. No public API changes.

This branch has not been deployed

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant