zstd: Read doc typo

[dezza]

should say "read"

Summary by CodeRabbit

• Bug Fixes
  • Updated documentation for the Read method to accurately reflect that it returns the number of bytes read.
  • Enhanced error handling in the Reset method to manage decoder states and nil readers more effectively.
  • Improved control flow in the nextBlock method to ensure error states are preserved during operations.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in the pull request primarily affect the zstd package, specifically the Decoder struct and its methods. The Read method's documentation has been corrected to clarify that it returns the number of bytes read. The Reset method has been improved with enhanced error handling, checking for the ErrDecoderClosed state and managing nil readers. Additionally, the nextBlock method has been modified to better handle error states, ensuring that errors are preserved during operations. Overall, the modifications focus on documentation clarity, error handling, and control flow improvements.

Changes

File	Change Summary
zstd/decoder.go	- Updated comment in Read method to clarify it returns bytes read. - Enhanced error handling in Reset method, checking for ErrDecoderClosed and managing nil readers. - Improved error state handling in nextBlock method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Decoder
    User->>Decoder: Call Read(p []byte)
    Decoder-->>User: Returns (bytesRead, error)
    
    User->>Decoder: Call Reset()
    Decoder->>Decoder: Check ErrDecoderClosed
    Decoder->>Decoder: Manage nil reader
    Decoder-->>User: Returns error if any

    User->>Decoder: Call nextBlock()
    Decoder->>Decoder: Handle error state
    Decoder-->>User: Returns next block or error

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

zstd/decoder.go (2)

Line range hint 32-38: Consider adding concurrency documentation

The concurrent operations in the decoder are complex. Consider adding documentation that explains:

• The purpose of each goroutine
• The data flow between channels
• The synchronization mechanisms used

---

Line range hint 4-4: Consider adding package documentation

The package would benefit from comprehensive documentation explaining:

• The high-level architecture
• Usage examples
• Performance characteristics
• Memory management strategies

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 826a08c and 501e4d7.

📒 Files selected for processing (1)

• zstd/decoder.go (1 hunks)

🔇 Additional comments (2)

zstd/decoder.go (2)

126-126: Documentation fix looks good!

The documentation now correctly states that the method returns the number of bytes "read" instead of "written", which is consistent with Go's io.Reader interface specification.

---

Line range hint 8-10: Improved error handling in Reset method

Early validation of the decoder's closed state prevents unnecessary operations and provides clear error feedback.

[klauspost]

I would say both are fine, and tbh I don't really think it is unclear as it is..

// Read bytes from the decompressed stream into p.
// Returns the number of bytes written (into p) and any error that occurred.