JuliaGeometry / GeometryBasics.jl

Basic Geometry Types
MIT License
165 stars 54 forks source link

Documentation is nonexistent #206

Open Cyrannosaurus opened 9 months ago

Cyrannosaurus commented 9 months ago

I want to use a Vec2f. I can't even find out what it is. People even need to guess what a Point is.

image image

How are people figuring out how to use this package?

Am I meant to find a PR like this? https://github.com/JuliaGeometry/GeometryBasics.jl/pull/97/commits/68c95dfa3a17f4dd13ee5dd0b38d564294a9f792#diff-f47a387b26bd0238e77cc474a77f21a9de0bbd9634f17eaf6847e634ea4fbdee

And then learn where Vec is defined? And keep digging and digging and digging?

Is this meant to be a private club? Or do you make things to share them with other people? Cause docs are how you do that.

rafaqz commented 9 months ago

You might want to rethink your tone.

Overworked, dedicated developers made this for free and build amazing things with it like Makie.jl

And you can use it too, for free. But also with no warranty of any kind.

No one here owes you anything at all

So sure, make an issue "please improve docs". It needs better docs. We all know that. Its a matter of available time and hands on deck.

But consider wether your tone encourages or discourages people to work for free, for you.

putianyi889 commented 7 months ago

While op is indeed offensive, it makes a point. Although this package/org is maintained by volunteers for free, you do owe people one thing, that is the name of the package/org. The name appears at the top whenever people who need help search for a geometry package, so this package gains more attention (associated with both help and expectation) than it deserves, where expectation brings complaint like the op.

There will be more time and hands from the public if there is some working document. The functionality is great but not properly presented.

rafaqz commented 7 months ago

Feel free to write that document, or to present things better. Asking poeople with no time to do something they dont need is a hard sell. In contrast just doing it would be widely appreciated.

Although im afraid there are major simplifications on the way, so waiting for that may be best.