Fix auto-generated link to the Java Future interface

Open Beginner friendly
#272 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
documentation, tooling

Research direction

Start at third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/ReferenceBuilder.java around line 132 and inspect how links for Java types are generated. Verify the handling of generic parameters and confirm that the generated ApiFuture link resolves to the Java Future interface documentation without them.

Written by the indexing model from the issue text.

Description

priority: p3 type: bug

The auto-generated link to the Java Future interface is broken: https://cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture (https://screenshot.googleplex.com/5GuhfNcyr23uDvf)

https://github.com/googleapis/java-docfx-doclet/blob/main/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/ReferenceBuilder.java#L132 needs to be updated to ignore generic parameters.

See b/355236843 for more context.

Dominant language
No language data
Stars
5
Forks
9
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 googleapis/java-docfx-doclet

All issues in googleapis/java-docfx-doclet

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.