docs: remove duplicate usage link and restore [^4] footnote reference in README#466
Open
ameyypawar wants to merge 2 commits into
Open
docs: remove duplicate usage link and restore [^4] footnote reference in README#466ameyypawar wants to merge 2 commits into
ameyypawar wants to merge 2 commits into
Conversation
… in README The "For more usage" list had "Quantization Types" twice (identical text and URL); remove the duplicate. Footnote [^4] was defined but never referenced, so its blog/doc links never rendered; attach the marker to the "Accelerated Index Build" claim it documents (100M vectors in 20 minutes via hierarchical K-means).
The footnote's links both anchor on #hierarchical-k-means, so place the inline marker on that clause (mirroring how [^5] sits on "sampling"), rather than on the "20 minutes" claim.
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
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
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.
What
Two small
README.mdfixes (docs-only, no functional change):Removed a duplicate usage link. The "For more usage, please read:" list contained Quantization Types twice — identical text and URL:
Restored the orphaned
[^4]footnote.[^4]is defined but never referenced inline, so its blog/doc links don't render. Every other footnote ([^1],[^2],[^3],[^5]) has an inline marker, so this adds[^4]to the Accelerated Index Build bullet — on the "hierarchical K-means" clause, matching the footnote's own#hierarchical-k-meansanchors:Happy to relocate the
[^4]marker (e.g. onto the "20 minutes" claim instead) if you prefer a different anchor.