13
orto
7y

I hate bad documentation but inconsistent documentation just feels like a personalized FU.

Comments
  • 3
    It could be worse. There could be no documentation...
  • 2
    @D--M I know luckily in this case it's a broadly used function and other languages have documentation for it.

    Eyyy best practices/standards 😀
  • 6
    IMHO, a clamp function needs no documentation. Same goes for most of the other functions shown in the screenshot.
  • 5
    @sirpalee of course they do.

    Your assuming that person reading the document are aware of all commonly used mathematical/comsci terms.

    Some people might have learned it in different language or used different terms.

    Hell something as simple as arctan()

    atan,invtan,tan_1

    needs to tell you deg/grad/rad as return type.

    Even isEquals states that it's fuzzy equals instead of exactly equal.

    Which are important differences
Add Comment