Skip to content

docs: update memory stream test link#999

Open
SSDWGG wants to merge 1 commit into
zlib-ng:developfrom
SSDWGG:docs/update-memory-stream-test-link
Open

docs: update memory stream test link#999
SSDWGG wants to merge 1 commit into
zlib-ng:developfrom
SSDWGG:docs/update-memory-stream-test-link

Conversation

@SSDWGG

@SSDWGG SSDWGG commented Jun 13, 2026

Copy link
Copy Markdown

Summary

Updates the memory stream example reference to point at the current test/test_stream.cc file instead of the old nmoinvaz/minizip test.c link.

Closes #996.

Testing

Not run; documentation-only link update.

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4f2fee79-9e94-4375-934a-7d246a696771

📥 Commits

Reviewing files that changed from the base of the PR and between d69cb0a and 71b5185.

📒 Files selected for processing (1)
  • doc/README.md

Walkthrough

The PR updates the Memory Stream usage documentation to direct readers to a current example file. Line 206 in doc/README.md replaces an outdated reference to test_stream_mem() in test.c with a pointer to test/test_stream.cc, clarifying the example location.

Changes

Documentation Update

Layer / File(s) Summary
Memory Stream example reference update
doc/README.md		 Memory Stream usage example reference corrected from test_stream_mem() in test.c to test/test_stream.cc.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating documentation to reference a different memory stream test file location.
Description check ✅ Passed The description clearly explains the change: updating a memory stream example reference from an old test.c file to the current test/test_stream.cc file, and references the related issue #996.
Linked Issues check ✅ Passed The PR directly addresses issue #996 by correcting the broken/unclear documentation link to point to the appropriate current test file (test/test_stream.cc).
Out of Scope Changes check ✅ Passed All changes are within scope: the PR modifies only doc/README.md to update the memory stream test reference, which directly fulfills the objective of fixing the broken link reported in issue #996.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Broken link in docs to test.c

1 participant

@SSDWGG