doc: buffer

[tonyfettes]

No description provided.

[peter-jerry-ye-code-review]

‼️ This code review is generated by a bot. Please verify the content before trusting it.

Here are three potential issues or observations from the provided git diff output:

1. Inconsistent Documentation Style:

   • The documentation for functions like length, is_empty, and contents has been updated to include detailed descriptions, parameters, and examples. However, some functions like write_uint64_be and write_uint64_le still lack detailed parameter descriptions or examples. For consistency, all functions should follow the same documentation style, including parameters, return values, and examples.

2. Potential Bug in write_char Function:

   • In the write_char function, the buffer is grown by 4 bytes (self.grow_if_necessary(self.len + 4)), but UTF-16LE encoding typically uses 2 bytes per character. This could lead to unnecessary memory allocation. The growth calculation should be adjusted to self.len + 2 to match the actual storage requirements for a UTF-16LE character.

3. Deprecated Function Usage:

   • The to_string and to_unchecked_string functions are marked as deprecated, but they are still present in the codebase. If these functions are no longer needed, they should be removed entirely to avoid confusion and maintain code cleanliness. Alternatively, if they are still in use, a migration plan should be documented to guide users toward the recommended alternatives (Buffer::contents).

These issues should be addressed to improve code quality, maintainability, and user experience.

[coveralls]

Pull Request Test Coverage Report for Build 4651

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 83.295%

---

Totals
Change from base Build 4650:	0.0%
Covered Lines:	4727
Relevant Lines:	5675

---

💛 - Coveralls

[bobzhang]

@Young-Flash the license check looks weird, would you have a look

[Young-Flash]

license header changed from 2024 to 2025, will promote it