README: Use absolute link for image #1158
Open
Conversation
This file contains 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
crates.io doesn't handle relative links well: rust-lang/crates.io#9939 (comment) It is a bit sad to do this, because now you need internet to render the README locally; OTOH if we ever decide to change the logo, the new one will be automatically visible in any place that uses absolute link.
|
|
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.
crates.io doesn't handle relative links well, so currently our logo is not visible on crates.io :(
Relevant crates.io issue: rust-lang/crates.io#9939
This PR changes the link to be absolute so that we are not bitten by this again.
It is a bit sad to do this, because now you need internet to render the README locally, and it just feels a bit wrong
to refer to the outside file instead of the file in the same filetree, but I don't see any better option for now.
OTOH if we ever decide to change the logo, the new one will be automatically visible in any place that uses absolute link, which is a plus.
Pre-review checklist
I added relevant tests for new features and bug fixes.I have provided docstrings for the public items that I want to introduce.I have adjusted the documentation in./docs/source/.I added appropriateFixes:annotations to PR description.