Include output details in the checkForChanges documentation

[azubieta]

The appimage::update::Updater::checkForChanges method returns true in the updateAvailable parameter if the method fails to download the update information (WTF!).

[TheAssassin]

Please provide more information, and an example AppImage for testing.

Generally, you should never use a result parameter without checking the return value. I suspect it's returning false. Looking at the code, updateAvailable shouldn't be changed. Check how you defined it, I bet the value isn't touched by the method. If you don't define the value, you can't blame it on the method; it doesn't make any guarantees about the value of this parameter unless it returns true.

[azubieta]

I suspect it's returning false

Indeed this happens when something goes wrong. Which means that no update can be retrieved at that moment and the 'updateAvailable' parameter should be also false. But it's not being modified by the checkForChanges method which is a bit misleading. As this is a design decision it should be clarified in the documentation.

Will relabel the issue.