[Bug report] Extra files are not reported

[liborjelinek]

Describe the bug

I would expect that extraneous files are reported as a difference, but they aren't. Is it a bug or an undocumented feature?

Optional link from https://dir-content-diff.readthedocs.io which documents the behavior that is expected

No response

To Reproduce

E.g.,
- dir1: foo.txt
- dir2: foo.txt bar.txt

but `dir_content_diff.compare_trees("dir1", "dir2") == {}`

Error

No diff detected, but dir2 contains extraneous files.

Additional context

No response

dir_content_diff Version in Use

1.12.1

Python Version

3.13

Operating system

MacOS

[adrien-berchet]

Hi @liborjelinek !
It is expected that files that are not present in the reference directory are not reported. If you want to check them, you have to switch the reference and compared directories. It is indeed not clear in the documentation, though it is consistent with the given example (the file sub_file_3.b is only present in the compared directory and is not reported). I will improve the doc about that.
In your case, is it possible to switch the reference and compared directories or would you need a new feature to report extraneous files?

[adrien-berchet]

Is it more clear with #83 ?

[liborjelinek]

Thanks for the super fast response 🌠. Ooops, I forgot that not swapping "reference" and "other" is crucial in your lib.

I'm used to the convention that both values have to be absolutely equal, no matter the argument order. E.g., in Pytest assert foo == bar, in unittest self.assertEqual("foo", "bar") or identity comparison foo == bar, ... everywhere it's just "are these two objects equal".

I suppose the only "fix" should be to emphasize this "fun fact" a bit in the docs 🤷‍♂️

[adrien-berchet]

Indeed, it's quite unusual and it's not really clear in the doc :-)
I improved #83 with a plain warning and I think it's much clearer now.

[adrien-berchet]

The doc was improved in #83 to clarify this fact.