Coder Social home page Coder Social logo

MathUtils.area() misleading about yuka HOT 3 CLOSED

mugen87 avatar mugen87 commented on September 13, 2024
MathUtils.area() misleading

from yuka.

Comments (3)

Mugen87 avatar Mugen87 commented on September 13, 2024

The documentation says:

Computes the signed area of a rectangle defined by three points.

I think this sentence already makes clear what the method does. Moreover:

This method can also be used to calculate the area of a triangle.

We expected that the reader knows how to compute the area of a triangle with the given result.

from yuka.

Mugen87 avatar Mugen87 commented on September 13, 2024

Besides, I prefer compact method names. Not a fan of stuff like thisMethodDoesSomethingVerySpecifc(). Even if it's descriptive, such style ruins code readability. The documentation can highlight implementation details.

from yuka.

Glidias avatar Glidias commented on September 13, 2024

Yea, it does state "rectangle" within the docs |=> parallelogram in non-right angled triangle cases. I guessed i missed out the first sentence.

from yuka.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.