Skip to content

Conversation

@adrien-berchet
Copy link
Member

No description provided.

This comment was marked as outdated.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@adrien-berchet adrien-berchet merged commit 0b65571 into main Sep 8, 2025
9 checks passed
@adrien-berchet adrien-berchet linked an issue Sep 12, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug report] Extra files are not reported

2 participants