search

Kwarrtz / render

A lightweight graphics library for the Elm programming language
BSD 3-Clause "New" or "Revised" License
15 stars 3 forks source link

Documentation Improvement #7

Open Kwarrtz opened 7 years ago

Kwarrtz commented 7 years ago

I'm opening this issue as a place to collect suggestions and grievances with regards to the documentation. The documentation for this library is, quite frankly, horrible, and no one is more aware of that than me. If you notice any inaccuracies in the documentation, or have specific ideas about where it most needs improvement, feel free to comment and I will get to them as soon as I can.

Also, I would be delighted if anyone else wants to take up this project themselves and submit a pull request for this.

iqualfragile commented 7 years ago

the documentation for the svg function is wrong, it only talks about the first two float arguments, but there are four, and the first two are not height and width, but position.

jxxcarlson commented 7 years ago

This line: |> svg 500 500 at http://package.elm-lang.org/packages/Kwarrtz/render/2.0.0/ needs to be corrected. That said, this is a VERY nice package.