Published oci-java-sdk-shaded-full javadoc does not refer to shaded classes
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 243
- Forks
- 171
- Avg merge
- 30m
- Merged PRs (30d)
- 4
Description
Here there is a reference to javax.ws.rs.client.ClientBuilder (the sole parameter the method declares). But the actual source code in question in the shaded artifact actually refers to shaded.com.oracle.oci.javasdk.javax.ws.rs.client.ClientBuilder (i.e. it's a shaded reference, by design).
I'm guessing the javadoc for this artifact was perhaps created before the shading process and then published with it?
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 comparing the published javadoc for oci-java-sdk-shaded-full 2.38.0 with the shaded source referenced in the issue, especially ClientConfigurator.customizeBuilder. Then inspect how the artifact's javadoc is generated and published. Done means the published documentation refers to shaded.com.oracle.oci.javasdk classes rather than the unshaded javax.ws.rs types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100