locationtech / locationtech/jts
Misleading documentation for LocationIndexedLine
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2.2k
- Forks
- 475
- Avg merge
- 14d 10h
- Merged PRs (30d)
- 1
Description
A user of NetTopologySuite reported that there is some misleading documentation for LocationIndexedLine.project and LocationIndexedLine.indexOf. Both state to do only almost similar things while they exactly the same thing:
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 inspecting the referenced LengthIndexedLine.java documentation around lines 116-136 and 185-197, then locate the corresponding LocationIndexedLine.project and indexOf documentation. Update the wording so the two methods are accurately distinguished, and confirm the resulting API documentation no longer makes misleading claims.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100