docs: fix stale compression references after v1.9.8 - #347
Merged
MPCoreDeveloper merged 1 commit intoAug 30, 2026
Merged
Conversation
Updates documentation and code comments that still described block compression as 'not implemented' or 'reserved' despite being shipped in v1.9.8 (PR MPCoreDeveloper#344).
saltus7
commented
Aug 30, 2026
CollaboratorAuthor
The CI failure appears unrelated to this PR. These are documentation and comment-only changes (3 markdown files + XML doc comments in one .cs file) that don't affect compiled code or test behavior. The XML warnings shown in the logs point to Happy to help investigate if needed, but this looks like either a flaky test or a pre-existing issue on master. |
Uh oh!
There was an error while loading. Please reload this page.
MPCoreDeveloper pushed a commit
that referenced
this pull request
Aug 30, 2026
…ionMode comments after #347 PR #347 updated compression references but (1) replaced the standard <copyright> header line with a bare file path (leaving a dangling </copyright>), and (2) documented the ScdbFileHeader.CompressionMode byte as 0=None/1=Brotli/2=GZip even though the byte is never written (always 0) - the mode is supplied via DatabaseOptions.BlockCompression and per-block state is the Compressed flag.
MPCoreDeveloper
commented
Aug 30, 2026
Owner
I see often 'problems' with the CLI runners , as they are not always fast enough for some tests i have to 'tweak' them or simply run them again and then they magically work . |
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Updates documentation and code comments that still described block compression as "not implemented" or "reserved" despite being shipped in v1.9.8 (PR #344).
Changes
docs/serialization/SERIALIZATION_AND_STORAGE_GUIDE.md— Updated compression table row and header field commentdocs/serialization/BINARY_FORMAT_VISUAL_REFERENCE.md— UpdatedCompressionModefield descriptionsrc/SharpCoreDB/Storage/Scdb/ScdbStructures.cs— UpdatedCompressionModefield XML doc and inline comment; updatedBlockFlags.Compressedenum doc.github/CODING_STANDARDS_CSHARP14.md— Updated stale TODO to reflect remaining streaming-compression workContext
These references were left stale after PR #344 merged block-level Brotli/GZip compression. This PR cleans up the documentation to match the shipped feature.