Skip to content

docs: improve accuracy of symlink-contents description in README.md #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
yacosta738 wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Draft

docs: improve accuracy of symlink-contents description in README.md #180

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ When `merge_strategy = "merge"`:
| Type | Description |
|--------------------|-------------------------------------------------------|
| `symlink` | Create a symlink to the source file/directory |
| `symlink-contents` | Create symlinks for each file in the source directory |
| `symlink-contents` | Create symlinks for each item in the source directory |

The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
filter which files to link.
Comment on lines +354 to 357
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 17, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Incomplete terminology update — "files" at line 357 still needs to be changed to "items".

The table entry on line 354 was correctly updated to "each item", but the immediately following paragraph on line 357 still reads "filter which files to link", which contradicts the updated wording and the stated intent (WalkDir iterates all entries — files and directories — at depth 1).

The AI summary states the change was applied in "two places", but only line 354 is annotated as changed (~); line 357 was left as-is.

📝 Proposed fix to align line 357 with the updated terminology 
-The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
-filter which files to link.
+The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
+filter which items to link.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| `symlink-contents` | Create symlinks for each item in the source directory |
The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
filter which files to link.
| `symlink-contents` | Create symlinks for each item in the source directory |
The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
filter which items to link.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 354 - 357, Update the README paragraph describing the
`symlink-contents` type so its terminology matches the table entry: change the
phrase "filter which files to link" to "filter which items to link" (referencing
the `symlink-contents` type and its optional `pattern` field) so the docs
correctly reflect that the pattern applies to directory entries (items) rather
than only files.

Expand Down
Loading