Autodoc: hyperlink URLs in text #19402
Merged
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
Closes ziglang#19265 This commit implements support for Markdown autolinks delimited by angle brackets. The precise syntax accepted is documented in the doc comment of `markdown.zig`.
This extension to the typical `<>` Markdown autolink syntax allows HTTP(S) links to be recognized in normal text without being delimited by `<>`. This is the most natural way to write links in text, so it makes sense to support it and allow documentation comments to be written in a more natural way.
|
It seems that the aarch64-macos-debug CI timed out, although unfortunately I don't have access to an aarch64-macos system to see if this is reproducible or just an unfortunate random occurrence. I'm not sure how these changes could have caused such a noticeable change in the build time; judging from other aarch64-macos-debug CI runs, it seems they usually take only 3.5-4.5 hours, not 6+ as in this case. |
|
Nice! |
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.
Closes #19265
There are two commits in this PR: the first one implements the "traditional" Markdown autolink syntax, using
<>to delimit the link, and the second one extends the parser to also recognize a more restricted form of links directly in plain text without any delimiters.Both forms of autolinks are currently represented in the standard library documentation. Here are some examples:
<>(these are a minority):#std.Uri#std.fmt.parse_float.convert_slow.convertSlow#std.fmt.parse_float.convert_eisel_lemire.convertEiselLemire#std.ascii(the subject of the linked issue)#std.unicode.fmtUtf8#std.mem.page_size