Chore: Absoluteify links for https://pypi.org/project/splitgraph readers#700
Merged
Chore: Absoluteify links for https://pypi.org/project/splitgraph readers#700
Conversation
- When PyPI renders README.md, these two links don't work in browser - Because this page comes up first when Googling 'splitgraph pypi' and #2 for 'splitgraph python' it seemed worth considering
onpaws
changed the title
Contributor
Author
|
Even though I'm observing a weird Hikari timeout, it seems unlikely to be related to this README.md change. So assuming we want this MR, I'm of the mind to merge it anyway, unless objections of course. @mildbyte any objections? |
Contributor
|
Nope! I'll merge this. Thanks! |
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.
I noticed that
README.mdincludes two relative links. While that's OK in local dev/Markdown contexts, it seems that these links render incorrectly in a browser (or at least a PyPI) setting.It seemed worth "absoluteifying" the links so to lower potential friction for PyPI users.
Demo
https://user-images.githubusercontent.com/182515/177992863-b4efdc5a-954d-41f8-9b53-5cbffd74199f.mp4