Polish README, docs, and Javadocs wording across Chronicle Bytes - #722
Draft
peter-lawrey wants to merge 4 commits into
Draft
Polish README, docs, and Javadocs wording across Chronicle Bytes#722peter-lawrey wants to merge 4 commits into
peter-lawrey wants to merge 4 commits into
Conversation
|
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.



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.adocexamples and narrative wording for consistency and readability.Polished supporting AsciiDoc docs, including:
FAQ.adocdecimal-rendering.adocproject-requirements.adocCleaned up Javadocs and comments across the Bytes API and mapped-bytes classes.
Standardised terminology across the codebase, including:
on heap→on-heapmemory mapped→memory-mappedstop bit→stop-bitfloating point→floating-pointthread safe/single threaded→thread-safe/single-threadedread only→read-onlybest effort→best-effortlow level→low-levelFixed a few small wording/typo issues, including:
I.e→I.e."This is a a commercial feature"→"This is a commercial feature").Impact