locationtech / locationtech/jts
[Query / Chore] Clarify the ConstrainedDelaunayTriangulator docs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2.2k
- Forks
- 475
- Avg merge
- 14d 10h
- Merged PRs (30d)
- 1
Description
Within the ConstrainedDelaunayTriangulator javadocs, it claims:
The Constrained Delaunay Triangulation of a polygon is a set of triangles covering the polygon, with the maximum total interior angle over all possible triangulation.
The "maximum total interior angle over all possible triangulation" is, from my knowledge of Delaunay, quite a vague descriptor and is quite unclear in what it is actually doing.
To my knowledge, is the interior angle not a constant and based on the polygon being triangulated? Clarification on this would be appreciated, and then added to the docs appropriately.
Thank you.
Contributor guide
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 locating the ConstrainedDelaunayTriangulator javadocs and reviewing the definition that describes the maximum total interior angle. Check the terminology against the surrounding implementation or project references, then revise the documentation so the criterion is unambiguous and verify that the Java documentation still builds cleanly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- computer-graphics, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100