JuliaGeometry / JuliaGeometry/GeometryBasics.jl
Documentation is nonexistent
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 215
- Forks
- 64
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 2
Description
I want to use a Vec2f. I can't even find out what it is. People even need to guess what a Point is.
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked pull request commit and tracing where Vec2f, Vec, and Point are defined in the repository. Identify the public types and usage details that a new user needs, then document them in the project's user-facing documentation. Done means users can find clear explanations of these types and how to use them without searching implementation history.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100