examples: fix whitespaces in Markdown links #3716
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
I've found a bug with how a link to "output widget examples" is rendered [here](https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20List.html#output). The root cause is that Markdown doesn't allow whitespaces in link destinations, so either whitespaces should be replaced with `%20` for the links to work or the entire URI should be enclosed in pointy bracketes (reference: https://spec.commonmark.org/0.30/#example-487). I've looked at neighbor links to see how it was done there and then decided to go with `%20` to make it uniform. Then I made a regexp to find all instances of such an issue: git grep -n -P '\[[^\]]*?\]\([^ )]*? [^)]*?\)' This patch adds `%20` to Markdown links in `docs/source/examples/` and changes an absolute URL pointing to https://ipywidgets.readthedocs.io/ to a relative link in one of the cases with the issue.
|
|
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.
I've found a bug with how a link to "output widget examples" is rendered here.
The root cause is that Markdown doesn't allow whitespaces in link destinations, so either whitespaces should be replaced with
%20for the links to work or the entire URI should be enclosed in pointy bracketes (reference: https://spec.commonmark.org/0.30/#example-487).I've looked at neighbor links to see how it was done there and then decided to go with
%20to make it uniform.Then I made a regexp to find all instances of such an issue:
This patch adds
%20to Markdown links indocs/source/examples/and changes an absolute URL pointing to https://ipywidgets.readthedocs.io/ to a relative link in one of the cases with the issue.