Skip to content

build(client): Update changesets for clarity and concision #24712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 27, 2025

Conversation

tylerbutler
Copy link
Member

Updates the changesets for the 2.41.0 release.

@Copilot Copilot AI review requested due to automatic review settings May 27, 2025 17:15
@tylerbutler tylerbutler requested a review from a team as a code owner May 27, 2025 17:15
@github-actions github-actions bot added changeset-present base: main PRs targeted against main branch labels May 27, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

A concise update to the changesets documentation for the 2.41.0 release to improve clarity and concision.

  • Revised descriptions for TreeAlpha identifier APIs and associated helper methods.
  • Clarified behavior of TreeAlpha.key2, TableSchema (alpha) APIs, and presence retrieval.
  • Updated documentation for experimental and legacy APIs for greater precision.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
.changeset/tricky-shrimps-hunt.md Updated identifier API descriptions for clarity.
.changeset/tough-parts-kick.md Revised TreeAlpha.key2 description and behavior notes.
.changeset/tabaxi-fellas-inspire.md Updated TableSchema (alpha) API wording.
.changeset/public-snakes-fetch.md Improved wording regarding UUID allocation and behavior.
.changeset/public-houses-add.md Expanded explanation of getPresence usage and deprecation.
.changeset/old-bees-itch.md Clarified comparePersistedSchema parameter changes.
.changeset/gentle-eggs-heal.md Updated description for objectIdNumber; minor grammatical fix.
.changeset/afraid-rice-feel.md Clarified support for unhydrated nodes in TreeAlpha.create.

tylerbutler and others added 2 commits May 27, 2025 10:17
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

#### TreeAlpha.identifier

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we enable markdown-lint for our changesets? Would catch these sorts of formatting issues. Alternatively, we could just run prettier on them

@tylerbutler tylerbutler merged commit 646a533 into microsoft:main May 27, 2025
28 checks passed
@tylerbutler tylerbutler deleted the changesets branch May 27, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
base: main PRs targeted against main branch changeset-present
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants