API documentation is not in sync with the code about blink-diff HOT 4 CLOSED

Hi Sarbbotam,

Yes, that is correct that either one is required. I described this in the Readme as:

• imageAPath Defines the path to the first image that should be compared (required; one or the other)
• imageA Supplies first image that should be compared (required; one or the other)
• imageBPath Defines the path to the second image that should be compared (required; one or the other)
• imageB Supplies second image that should be compared (required; one or the other)

I see that this not ideal, but I don't know of any other way to describe it through the API documentation. I can either declare all optional, or declare all required. Since some of them are required, I chose to "define" them all as required in the API-documentation but described it in the Readme.
What would prefer? And why?

from blink-diff.

I had been referring the previously stated example and I was always getting a failed output, while passing the desired parameter to the BlinkDiff constructor. Then I started looking into the API documentation and was completely confused what needs to be done, till I looked into the code and figured out.

I suppose, the statement '(required; one or the other)' does not seems to convey its intention. I would recommend to get it removed from the options'/parameters' description and explicitly call out a section on the mandatory parameter, followed by examples.

Thanks,

from blink-diff.

I don't want to remove the statement in the documentation as it might lead to more confusion. I modified it a little bit since I also believe that this wasn't really helpful.
However, I added also another example per your suggestion and I hope I made it with this a bit clearer.
See commit 3d7fd9c.

from blink-diff.

looks better 🍁

from blink-diff.