locationtech / locationtech/spatial4j
Recent deprecations in SpatialContext do not include new method to use
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 961
- Forks
- 172
- PR merge metrics
- No merged PRs in 30d
Description
I am looking to use spatial4j in my application. Looking at the source code for SpatialContext I noticed several methods are noted as being @deprecated the problem is the Javadocs do not explain what the replacement methods are or what alternatives are available?
I noticed after a while you had put a new class ShapeFactory the Deprecations should list where to create the shape and what the new methods in ShapeFactory should use.
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 in the SpatialContext source and review each deprecated method alongside the newer ShapeFactory class. Update the deprecation Javadocs to identify the replacement methods, explain where shapes should be created, and point to available alternatives. Done means the deprecated APIs clearly direct users to the appropriate ShapeFactory methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100