Skip to content

Polish README, docs, and Javadocs wording across Chronicle Bytes - #722

Draft
peter-lawrey wants to merge 4 commits into
developfrom
review/polish
Draft

Polish README, docs, and Javadocs wording across Chronicle Bytes#722
peter-lawrey wants to merge 4 commits into
developfrom
review/polish

Conversation

@peter-lawrey

@peter-lawrey peter-lawrey commented Apr 24, 2026

Copy link
Copy Markdown
Member

Polishes wording across the README, supporting AsciiDoc files, public API Javadocs, internal comments, and a small number of text strings.

This PR is primarily a documentation and terminology cleanup. It standardises wording such as on-heap, memory-mapped, stop-bit, floating-point, thread-safe, single-threaded, read-only, best-effort, and low-level, and fixes a few minor typos and phrasing issues.

This is an extension to #709

What changed

  • Updated README.adoc examples and narrative wording for consistency and readability.

  • Polished supporting AsciiDoc docs, including:

    • FAQ.adoc
    • decimal-rendering.adoc
    • project-requirements.adoc
  • Cleaned up Javadocs and comments across the Bytes API and mapped-bytes classes.

  • Standardised terminology across the codebase, including:

    • on heapon-heap
    • memory mappedmemory-mapped
    • stop bitstop-bit
    • floating pointfloating-point
    • thread safe / single threadedthread-safe / single-threaded
    • read onlyread-only
    • best effortbest-effort
    • low levellow-level
  • Fixed a few small wording/typo issues, including:

    • “set up” wording in the README
    • I.eI.e.
    • “pre-pended” → “prepended”
    • removal of the duplicated article in the commercial-feature message ("This is a a commercial feature""This is a commercial feature").

Impact

  • No intended functional or behavioural change.
  • Improves consistency between README, docs, and generated Javadocs.
  • Makes API wording more precise and easier to scan.
  • The only externally visible text change in production code is the corrected commercial-feature message wording.

@sonarqubecloud

Copy link
Copy Markdown

@peter-lawrey peter-lawrey changed the title [codex] Polish docs wording Polish README, docs, and Javadocs wording across Chronicle Bytes Apr 24, 2026
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