Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Simplify the "minimum required versions" page using MyST customized URL schemes #3383

Merged
merged 3 commits into from
Aug 9, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Aug 7, 2024

@seisman seisman added the maintenance Boring but important stuff for the core devs label Aug 7, 2024
@seisman seisman added this to the 0.13.0 milestone Aug 7, 2024
@seisman seisman added the needs review This PR has higher priority and needs review. label Aug 7, 2024
@@ -1,3 +1,20 @@
---
myst:
# Customized URI schemes that are converted to external links
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. Based on how I understand the documentation so far and being consistent with url_schemes:, using "URL" seem to be better, here. If we use "URI" I feel it can make sense to introduce this shortcut.

Suggested change
# Customized URI schemes that are converted to external links
# Customized URL schemes that are converted to external links

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me it seems URI is still the right term here since an URL is already a link (a location) while an URI is just the identifier that is then converted to an URL.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MyST documentation uses URI: https://myst-parser.readthedocs.io/en/latest/configuration.html

For the difference between URI and URL, see https://www.godaddy.com/resources/ae/skills/uri-vs-url.

I agree with @michaelgrund that URI is the right term.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, looks like the MyST documentation is not 100 % consistent here 🙃:

at https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#customising-external-url-resolution

To specify a custom list of URL schemes, you can set the myst_url_schemes configuration option. By default this is set to ["http", "https", "ftp", "mailto"].

but at https://myst-parser.readthedocs.io/en/latest/configuration.html

myst_url_schemes | URI schemes that are converted to external links (default: {'http': None, 'https': None, 'mailto': None, 'ftp': None})

Copy link
Member Author

@seisman seisman Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway, it's just one comment line and it doesn't hurt if it's correct or not.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading https://www.godaddy.com/resources/ae/skills/uri-vs-url

URIs can be further divided into two categories: URLs and URNs. [...]
The key difference is: all URLs are URIs, but not all URIs are URLs.

So, let's keep URIs here.

doc/minversions.md Outdated Show resolved Hide resolved
doc/minversions.md Outdated Show resolved Hide resolved
@seisman seisman merged commit 16c859c into main Aug 9, 2024
9 checks passed
@seisman seisman deleted the doc/minversions branch August 9, 2024 09:26
@seisman seisman removed the needs review This PR has higher priority and needs review. label Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants