[doc] Use Compressed_Literals_Block in Size_Format bullet for consistency (fixes #4673)#4676
Open
LeSingh1 wants to merge 1 commit into
Open
[doc] Use Compressed_Literals_Block in Size_Format bullet for consistency (fixes #4673)#4676LeSingh1 wants to merge 1 commit into
LeSingh1 wants to merge 1 commit into
Conversation
…ency The Size_Format bullet in the Literals_Block_Type section used `Compressed_Block` when describing which literals block types carry a `Compressed_Size` field. `Compressed_Block` is the *block-level* type defined in section 3.1.1.1; the value the Literals_Block_Type enum can hold (and that the parallel bullet for Raw / RLE block types uses) is `Compressed_Literals_Block`. The Size_Format sub-section that follows already uses `Compressed_Literals_Block` in its heading, so this is the only remaining mismatch. Fixes facebook#4673.
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
1 participant
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.
Fixes #4673.
In
doc/zstd_compression_format.md, theSize_Formatbullet in theLiterals_Block_Typesection currently reads:Compressed_Blockis the block-level type defined in section 3.1.1.1 (the four-wayRaw_Block/RLE_Block/Compressed_Block/Reservedenum on line 357). The value theLiterals_Block_Typeenum can actually hold here, and the one the parallel bullet for theRaw_Literals_Block/RLE_Literals_Blockpair already uses, isCompressed_Literals_Block.The sub-section that immediately follows ("
Size_FormatforCompressed_Literals_BlockandTreeless_Literals_Block", line 521) already usesCompressed_Literals_Blockin its heading, so this is the only remaining occurrence using the wrong term in this section.This PR changes that one occurrence to
Compressed_Literals_Blockto match.