Git Product home page Git Product logo

Comments (8)

klawr avatar klawr commented on September 26, 2024

The wiki is almost up to date now.
I hope this will be sufficient:
https://github.com/goessner/g2/wiki/g2.mec

from g2.

jauhl avatar jauhl commented on September 26, 2024

Please also update https://github.com/goessner/g2/blob/master/docs/api/g2.mec.md which is imho even more important.

from g2.

klawr avatar klawr commented on September 26, 2024

I see... The problem is not that they are not mentioned... The headline is wrong due to the automatic naming of js2md.
g2.pol() is just the first symbol. as you can see the description is for all symbols at once, since they dont differ in usage:
https://github.com/goessner/g2/blob/master/docs/api/g2.mec.md#g2pol

I will have a look at how to group them sufficiently.

from g2.

klawr avatar klawr commented on September 26, 2024

I have not found a solution to group them, but this way it is more correct anyway.
Please check if this is okay now: https://github.com/goessner/g2/blob/master/docs/api/g2.mec.md#g2+pol

from g2.

jauhl avatar jauhl commented on September 26, 2024

Looks fine but maybe also break down the example from pol() to the corresponding methods.

g2().view({cartesian:true})
    .pol({x:20,y:75})
    .gnd({x:60,y:75})
    .nod({x:100,y:75})
    .dblnod({x:140,y:75})
    .nodfix({x:180,y:75})
    .nodflt({x:220,y:75})
    .origin({x:260,y:75})

from g2.

klawr avatar klawr commented on September 26, 2024

I thought about that, but don't you think that's too much repetition then?

from g2.

jauhl avatar jauhl commented on September 26, 2024

No. Since e.g. dblnod() does not depend on pol() i don't want to have to search around and look up how it works in other methods. And since

.gnd({x:60,y:75})
    .nod({x:100,y:75})
    .dblnod({x:140,y:75})
    .nodfix({x:180,y:75})
    .nodflt({x:220,y:75})
    .origin({x:260,y:75})

can be excluded from the pol() example, it's not much more lines of documentation in total.

from g2.

klawr avatar klawr commented on September 26, 2024

Changed according to your suggestion:
https://github.com/goessner/g2/blob/master/docs/api/g2.mec.md#g2+pol

from g2.

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.