Recent deprecations in SpatialContext do not include new method to use

Open
#137 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
documentation

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.

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.

Dominant language
Java
Stars
961
Forks
172
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from locationtech/spatial4j

All issues in locationtech/spatial4j

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.