Docs: Clarify how reference and compared directories are processed#83
Merged
adrien-berchet merged 3 commits intomainfrom Sep 8, 2025
Merged
Docs: Clarify how reference and compared directories are processed#83adrien-berchet merged 3 commits intomainfrom
adrien-berchet merged 3 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the dir-content-diff library by clarifying how reference and compared directories are processed during comparison operations. The changes make it more explicit that the order of parameters matters and that extraneous files in the compared directory are ignored.
- Updated section introduction to be more direct and actionable
- Added explicit explanation of reference vs compared directory behavior
- Added warning callout about parameter order importance
- Clarified that only files present in both directories are compared
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.