docs: fix broken README link in rb_test docstring for Bazel registry#386
Open
georgesfarah wants to merge 1 commit into
Open
docs: fix broken README link in rb_test docstring for Bazel registry#386georgesfarah wants to merge 1 commit into
georgesfarah wants to merge 1 commit into
Conversation
The Bazel registry (registry.bazel.build) renders rule docstrings as HTML. The relative path `../../README.md#code-coverage` resolves against registry.bazel.build instead of the GitHub repo, resulting in a 404. Replace with an absolute GitHub URL so the link works correctly on both GitHub and the registry. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
rb_testdocstring links to../../README.md#code-coverage, which is a relative file path that works on GitHub but breaks on the Bazel registry (registry.bazel.build), where it resolves to a 404.You can see the broken link here: https://registry.bazel.build/docs/rules_ruby (in the
rb_test> Code Coverage section)Test plan
Manual testing:
rb_testrule documentation, scroll to the "Code Coverage" section