docs: clarify semverCompare return value

The return value for `semverCompare` was not explicitly listed in the docs,
and I had to go check in the source code wether it's actually a boolean.

By listing the return type in the docs, we can make usage easier for other people.