Skip to content

Conversation

@gaius-qi
Copy link
Member

@gaius-qi gaius-qi commented Sep 2, 2025

Description

This pull request updates the documentation for the PieceContent value format in the src/tlv/piece_content.rs file to accurately reflect the actual sizes of several fields. The main changes clarify the byte sizes for metadata, digest, and parent ID length fields, as well as correct the cost field size.

Documentation updates for value format:

  • Changed the "Metadata Length," "Digest Length," and "Parent ID Length" fields from 8 bytes to 4 bytes in the documentation to match the actual implementation.
  • Corrected the "Digest" field description to indicate it is variable length (was previously fixed at 32 bytes).
  • Updated the "Cost" field size from 64 bytes to 8 bytes in the documentation.

Related Issue

Motivation and Context

Screenshots (if appropriate)

@gaius-qi gaius-qi self-assigned this Sep 2, 2025
@gaius-qi gaius-qi added the enhancement New feature or request label Sep 2, 2025
chlins
chlins previously approved these changes Sep 2, 2025
Copy link
Member

@chlins chlins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Signed-off-by: Gaius <gaius.qi@gmail.com>
Copy link
Member

@chlins chlins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@chlins chlins merged commit e57ec55 into main Sep 2, 2025
5 checks passed
@chlins chlins deleted the feature/docs branch September 2, 2025 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

3 participants