locationtech / locationtech/jts
Polygonizer extractOnlyPolygonal documentation
Open
Nobody has claimed this yet.
doc
type-improvement
- Dominant language
- Java
- Stars
- 2.2k
- Forks
- 475
- Avg merge
- 14d 10h
- Merged PRs (30d)
- 1
Description
I found that extractOnlyPolygonal option is quite difficult to understand and would desserve more documentation.
- use case where I found it useful : building polygons from their boundaries (avoids to build polygons in original holes)
- situation where it makes no sense : on a linework representing limits of a coverage, the option build some faces and omit others with an unpredictable pattern (keep some adjacent faces and omit others). Worse : running several times the algo produces different patterns.
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 extractOnlyPolygonal option and its existing Polygonizer documentation. Document the boundary-building use case, explain when the option is inappropriate for coverage limit linework, and clarify the observed differing face-selection patterns so the resulting guidance matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100