opensearch-project / opensearch-project/opensearch-java
Document when the `RestClientOptions`/`RestClientTransport` will be removed
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 165
- Forks
- 250
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 26
Description
At the moment the javadocs of RestClientOptions/RestClientTransport say that "...is scheduled for removal in later versions". Bot don't mention in which version.
It would be helpful to provide concrete version.
IMHO, the v3 is good canditate for such breaking changes.
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 with the Javadocs for RestClientOptions and RestClientTransport and review the repository's release or compatibility documentation for the planned removal policy. Confirm which release should remove these types with maintainers, then update both Javadocs to name that version and verify the documentation changes build successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100