Skip to content
This repository has been archived by the owner on Nov 22, 2023. It is now read-only.

Documentation improvements #194

Open
asinghvi17 opened this issue Feb 10, 2020 · 4 comments
Open

Documentation improvements #194

asinghvi17 opened this issue Feb 10, 2020 · 4 comments

Comments

@asinghvi17
Copy link

asinghvi17 commented Feb 10, 2020

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
Copy link

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
Copy link

I can't even find out what a Vec2f is

@Cyrannosaurus
Copy link

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.
image

@juliohm
Copy link
Member

juliohm commented Nov 22, 2023

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants