Skip to content

Commit dc97163

Browse files
Docs: Clarify how reference and compared directories are processed
1 parent 7db7243 commit dc97163

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ import dir_content_diff
6363
dir_content_diff.compare_trees("reference_dir", "compared_dir")
6464
```
6565

66-
This code will return an empty dictionary because no difference was detected.
66+
If all the files are identical, this code will return an empty dictionary because no difference
67+
was detected. This is because `dir-content-diff` is only looking for files in the compared directory
68+
that are also present in the reference directory. Thus extraneous files from the compared directory
69+
are not considered.
6770

6871
If ``reference_dir/file_1.c`` is the following JSON-like file:
6972

0 commit comments

Comments
 (0)