Skip to content

docs: clarify package descriptions - #86

Merged
sedghi merged 1 commit into
mainfrom
agent/refresh-codec-readmes
Aug 13, 2026
Merged

docs: clarify package descriptions#86
sedghi merged 1 commit into
mainfrom
agent/refresh-codec-readmes

Conversation

@sedghi

@sedghi sedghi commented Aug 13, 2026

Copy link
Copy Markdown
Member

Why

The previous release attempt pushed its version commit and package tags before failing during GitHub release creation. Rerunning that original pipeline checked out the older commit, so lerna publish from-package could not see the bumped package versions.

This documentation-only change intentionally creates a fresh, non-skipped pipeline from the latest main. Markdown remains excluded from Lerna's changed-package calculation, so this does not introduce another version bump while allowing the existing unpublished versions to proceed through the publication step.

What changed

  • Clarified the opening package description in each of the eight package READMEs.
  • Kept the diff to exactly one replacement line per README.

Validation

  • git diff --check origin/main...HEAD
  • Confirmed each README has exactly one added and one removed line.
  • lerna changed reports no changed packages, as expected for Markdown-only changes.

Summary by CodeRabbit

  • Documentation
    • Clarified package descriptions using consistent “JavaScript/WebAssembly” terminology.
    • Improved capitalization, punctuation, and wording across codec documentation.
    • Explicitly documented browser and Node.js support where applicable.
    • Updated OpenJPEG documentation to identify its Emscripten-based implementation and contributors.
    • Standardized “Pure JavaScript,” “Big Endian,” and “Little Endian” terminology.

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 169f7963-5037-4f43-8800-424d1f24fa96

📥 Commits

Reviewing files that changed from the base of the PR and between d89ff94 and c92af26.

📒 Files selected for processing (8)
  • packages/big-endian/README.md
  • packages/charls/README.md
  • packages/dicom-codec/README.md
  • packages/libjpeg-turbo-12bit/README.md
  • packages/libjpeg-turbo-8bit/README.md
  • packages/little-endian/README.md
  • packages/openjpeg/README.md
  • packages/openjphjs/README.md

📝 Walkthrough

Walkthrough

Updated eight package README descriptions. The edits expand JavaScript/WebAssembly terminology, apply sentence-case wording, clarify platform support, and revise endianness terms. No public declarations or implementation code changed.

Changes

README terminology updates

Layer / File(s) Summary
Package description wording
packages/*/README.md
README descriptions use revised JavaScript, WebAssembly, platform, punctuation, capitalization, and endianness wording.

Estimated code review effort: 1 (Trivial) | ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/refresh-codec-readmes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sedghi
sedghi marked this pull request as ready for review August 13, 2026 22:06
@sedghi
sedghi merged commit 8634194 into main Aug 13, 2026
11 checks passed
@sedghi
sedghi deleted the agent/refresh-codec-readmes branch August 13, 2026 22:06
@codspeed-hq

codspeed-hq Bot commented Aug 13, 2026

Copy link
Copy Markdown

Merging this PR will degrade performance by 16.52%

⚡ 1 improved benchmark
❌ 1 regressed benchmark
✅ 51 untouched benchmarks
⏩ 66 skipped benchmarks1

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation decode CT-512x512-near-lossless.JLS (.81 near-lossless) — warm 19.8 ms 37.9 ms -47.76%
Simulation HTJ2K Lossless (.201) 189 ms 141.7 ms +33.38%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing agent/refresh-codec-readmes (c92af26) with main (8634194)2

Open in CodSpeed

Footnotes

  1. 66 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

  2. No successful run was found on main (d89ff94) during the generation of this report, so 8634194 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

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