search

kotools / types

Explicit types for Kotlin Multiplatform.
https://types.kotools.org
MIT License
90 stars 6 forks source link

📝 Documentation improvement of `compareTo` methods #705

Open LVMVRQUXL opened 3 months ago

LVMVRQUXL commented 3 months ago

📝 Description

We want to improve the documentation of the compareTo methods by doing the following:

// For the Zero type, replace...
Returns zero if this number equals the other one, a negative number if it's less than the other one, or a positive number if it's greater than the other one.
// ... by
Returns a negative integer, zero, or a positive integer as this number is less than, equal to, or greater than the other one.

This wording change should be done similarly on all compareTo methods provided by Kotools Types.