Repository navigation
docs(release): API review notes for the 1.0 sign-off - #297
Open
michaelstonis wants to merge 2 commits into
Open
michaelstonis wants to merge 2 commits into
michaelstonis wants to merge 2 commits into
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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">onKumikoScrollerandKumikoAnnouncements, and two "cancelled" to "canceled" fixes.Must-fix before the freeze:
eng/update-public-api.shre-adds the Uno heads' generatedGlobalStaticResourceslines to Unshipped (RS0025 once they are in Shipped) and deletes a head'sPublicAPI.Shipped.txtwhen its Unshipped file comes out empty.Decisions for the maintainer (recommendations):
#AARRGGBB.CellEditorContextand removeCustomEditorFactorywhile still in preview.RenderMode = Auto: keep Hardware, gate the release on one physical low-end device pass.Builds: Core, SkiaSharp, MAUI and Uno 0 warnings; DocsIdentifiers and
dotnet formatclean.