Documentation improvements

JuliaGeometry / GeometryTypes.jl

Geometry types for Julia

Other

67 stars 41 forks source link

Documentation improvements #194

Open asinghvi17 opened 4 years ago

asinghvi17 commented 4 years ago

For newbies, it would be nice to improve the documentation a little:

Clarify what Hyper means (just signifying generalizability to $n$-dimensions)
Simpler examples with convenience functions (Rect, Sphere, Circle, ...)
Explicitly clarify what f0 means

mileslucas commented 4 years ago

I agree a lot. I have been here a few times and looked through the documentation to see if things like triangles are implemented and I see nothing so I turn away. It wasn't until recently I actually dove into the source code and saw the over 100 exports and was truly astounded that so little is documented in the documentation. It turns out this code is extremely useful for me but I just never knew it was usable. Now, too, I have to sift through source code to find the functionality I want instead of just seeing it in the docs.

Cyrannosaurus commented 9 months ago

I can't even find out what a Vec2f is

Cyrannosaurus commented 9 months ago

The documentation is laughable. What is a point? Docs don't know. A vector? Well, I guess it exists, but oh, you want to know how to go about using it? No way buddy, figure it out yourself.

juliohm commented 9 months ago

I don't think GeometryTypes.jl is maintained anymore. Take a look at Meshes.jl if you are doing geometric processing or GeometryBasics.jl if you are simply trying to visualize basic geometries.