fix: allow overriding source directory per class in GitHub links#285
Merged
jinseopkim0 merged 2 commits intomainfrom Feb 4, 2026
Merged
fix: allow overriding source directory per class in GitHub links#285jinseopkim0 merged 2 commits intomainfrom
jinseopkim0 merged 2 commits intomainfrom
Conversation
Currently, the doclet assumes the source directory name matches the artifact ID when generating GitHub links. This leads to broken links for libraries where they differ, such as Firestore (artifact: `google-cloud-firestore`, directory: `google-cloud-firestore-admin` for `FirestoreAdminClient`). This change adds an optional `library_path_overrides` map to `RepoMetadata` and updates `ClassBuilder` to check this map using the simple class name before falling back to the artifact ID. Fixes: b/442875200
jinseopkim0
force-pushed
the
firestore-name
branch
from
99be1f5 to
6f10b57
Compare
jinseopkim0
changed the title
zhumin8
approved these changes
Jan 29, 2026
| method.setAccessible(true); | ||
| String html = (String) method.invoke(builder, classElement, repoMetadata); | ||
|
|
||
| // 4. Verify link contains "google-cloud-firestore-admin" and the double slash "//" |
Contributor
There was a problem hiding this comment.
maybe unrelated: why are the double slash "//" necessary?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently, the doclet assumes the source directory name matches the
artifact ID when generating GitHub links. This leads to broken links
for libraries where they differ, such as Firestore (artifact:
google-cloud-firestore, directory:google-cloud-firestore-adminfor
FirestoreAdminClient).This change adds an optional
library_path_overridesmap toRepoMetadataand updatesClassBuilderto check this map using thesimple class name before falling back to the artifact ID.
Fixes: b/442875200