📝 Fix inaccurate EntryBuilder factory method summaries

[ChanTsune]

Also fix misleading path strings in symlink/hard link examples where "path/of/target" was used for the link name and "path/of/source" for the link target, reversing the actual semantics.

Summary by CodeRabbit

• Documentation
  • Improved documentation for entry builder constructors with clearer descriptions of entry types and refined examples.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f4e52f4-4a0e-49e3-8593-da3dede33a3b

📥 Commits

Reviewing files that changed from the base of the PR and between c683e36 and 528d437.

📒 Files selected for processing (1)

• lib/src/entry/builder.rs

---

📝 Walkthrough

Walkthrough

Updated Rustdoc comments for EntryBuilder constructors (new_dir, new_file, new_symlink, new_hard_link) to explicitly clarify the return types and corrected example "target/source" ordering in symlink and hardlink constructor documentation. No implementation changes.

Changes

Cohort / File(s)	Summary
EntryBuilder Rustdoc Updates lib/src/entry/builder.rs	Clarified Rustdoc descriptions for constructors and updated symlink/hardlink examples with corrected EntryName ("path/of/link") and EntryReference ("path/of/target") ordering.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• 💥 Remove deprecated apis since 0.27.x #2370: Updates to EntryBuilder constructors in the same file, including removal of deprecated new_symbolic_link method.
• 🐛 Fixed dropped leading slash in tar2pna and zip2pna #2792: Changes to EntryBuilder constructor signatures and usage patterns in lib/src/entry/builder.rs.

Suggested labels

lib

Poem

🐰 A rabbit hops through docs so fine,
With symlinks straight and examples aligned,
Where targets point and sources shine,
The builders' paths are now clearly defined! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly summarizes the main change: fixing inaccurate documentation summaries for EntryBuilder factory methods.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch lib/fix-doc-builder-summaries

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[gemini-code-assist]

Code Review

This pull request updates the documentation for EntryBuilder methods, including new_dir, new_file, new_symlink, and new_hard_link, to more accurately describe their return types and parameters. Specifically, it clarifies that these methods return an EntryBuilder and improves the naming in example code to better distinguish between the link path and its target. I have no feedback to provide.