Skip to content
This repository has been archived by the owner on Dec 5, 2022. It is now read-only.

More understandable documentation for line class #65

Open
RobotJente opened this issue Apr 20, 2020 · 0 comments
Open

More understandable documentation for line class #65

RobotJente opened this issue Apr 20, 2020 · 0 comments
Assignees

Comments

@RobotJente
Copy link
Contributor

The documentation of the forward and general intersect classes is convoluted. This can be fixed by making a Halfline class, since currently the forward intersect is the only method that treats a line as a half line, which does not make sense, both in design and mathematically. Additionally, I'm pretty sure the current documentation for forwardIntersect is incomplete, as it is unclear what a direction vector is, and what the point b is.

Additionally, the documentation for the "general intersect" needs to be shorter. Less words, and more precise. Use math if needed. See the updated forwardIntersect documentation for inspiration

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

No branches or pull requests

2 participants