Skip to content

docs: clean up code comments - #3023

Merged
christianhg merged 1 commit into
mainfrom
comment-review
Jul 25, 2026
Merged

docs: clean up code comments#3023
christianhg merged 1 commit into
mainfrom
comment-review

Conversation

@christianhg

@christianhg christianhg commented Jul 24, 2026

Copy link
Copy Markdown
Member

Deletes comments that restate the code, tightens comments whose why is buried in narration, and corrects inaccurate ones.

@changeset-bot

changeset-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b009e5a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel

vercel Bot commented Jul 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
portable-text-editor-documentation Ready Ready Preview, Comment Jul 24, 2026 1:22pm
portable-text-example-basic Ready Ready Preview, Comment Jul 24, 2026 1:22pm
portable-text-playground Ready Ready Preview, Comment Jul 24, 2026 1:22pm

Request Review

@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

📦 Bundle Stats — @portabletext/editor

Compared against main (4352ef3d)

@portabletext/editor

Metric Value vs main (4352ef3)
Internal (raw) 807.5 KB -
Internal (gzip) 155.1 KB -
Bundled (raw) 1.42 MB -
Bundled (gzip) 319.4 KB -
Import time 97ms -1ms, -1.0%

@portabletext/editor/behaviors

Metric Value vs main (4352ef3)
Internal (raw) 467 B -
Internal (gzip) 207 B -
Bundled (raw) 424 B -
Bundled (gzip) 171 B -
Import time 2ms -0ms, -2.5%

@portabletext/editor/plugins

Metric Value vs main (4352ef3)
Internal (raw) 2.7 KB -
Internal (gzip) 894 B -
Bundled (raw) 2.5 KB -
Bundled (gzip) 827 B -
Import time 7ms -0ms, -0.6%

@portabletext/editor/selectors

Metric Value vs main (4352ef3)
Internal (raw) 82.7 KB -
Internal (gzip) 15.4 KB -
Bundled (raw) 78.4 KB -
Bundled (gzip) 14.3 KB -
Import time 8ms +0ms, +1.3%

@portabletext/editor/traversal

Metric Value vs main (4352ef3)
Internal (raw) 28.1 KB -
Internal (gzip) 5.6 KB -
Bundled (raw) 28.1 KB -
Bundled (gzip) 5.5 KB -
Import time 6ms +0ms, +1.8%

@portabletext/editor/utils

Metric Value vs main (4352ef3)
Internal (raw) 30.6 KB -
Internal (gzip) 6.4 KB -
Bundled (raw) 28.2 KB -
Bundled (gzip) 6.1 KB -
Import time 6ms +0ms, +1.1%

🗺️ . · ./behaviors · ./plugins · ./selectors · ./traversal · ./utils · Artifacts

Details
  • Import time regressions over 10% are flagged with ⚠️
  • Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

📦 Bundle Stats — @portabletext/markdown

Compared against main (4352ef3d)

Metric Value vs main (4352ef3)
Internal (raw) 53.8 KB -
Internal (gzip) 9.8 KB -
Bundled (raw) 348.9 KB -
Bundled (gzip) 96.3 KB -
Import time 40ms +1ms, +2.0%

🗺️ View treemap · Artifacts

Details
  • Import time regressions over 10% are flagged with ⚠️
  • Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

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.

1 participant