fix: ignore punctuation at end of URL #157
Merged
Conversation
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
Problem: URLs in help docs may be followed by "." or ",", but it's usually not intended as part of the URL. Examples from neovim/neovim#36597: https://luarocks.org, https://neovim.io/doc/, Solution: - Treat "." as a word. - Assume that `)].,` at the end of a URL is not part of the URL. Now NESTED parens work: (https://neovim.io/doc/user/vimfn.html#get()-blob) but it's not possible to support a trailing closing paren ")": (https://neovim.io/doc/user/api.html#nvim_input()) workaround: URL-encode the trailing paren: (https://neovim.io/doc/user/api.html#nvim_input%28%29) URL cannot contain a closing bracket `]` anywhere in the URL. (Workaround: URL-encode the bracket.) This is a tradeoff so that markdown hyperlinks work: [https://example.com](https://example.com) Bonus(?): now the inline code in this example is recognized: `foo`.bar
justinmk
commented
Dec 6, 2025
| url: (https://neovim.io/doc/user/(foo)#yay) | ||
| markdown: [https://neovim.io/doc/user/#yay](https://neovim.io/doc/user/#yay). | ||
| url: (https://neovim.io/doc/user/vimfn.html#get()-blob) | ||
| markdown: [https://neovim.io/doc/user/#yay[foo](https://neovim.io/doc/user/#yay). |
Member
Author
There was a problem hiding this comment.
We probably should not try to support "markdown hyperlinks". Can revisit that in a followup, and then ] in URLs will work.
Member
Author
|
CI failures will be fixed by neovim/neovim#36741 . |
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.
Fix neovim/neovim#36832
Fix #107
Problem:
URLs in help docs may be followed by "." or ",", but it's usually not intended as part of the URL.
Examples from neovim/neovim#36597:
Solution:
)].,at the end of a URL is not part of the URL.Now NESTED parens work:
but it's not possible to support a trailing closing paren ")":
workaround: URL-encode the trailing paren:
URL cannot contain a closing bracket
]anywhere in the URL. (Workaround: URL-encode the bracket.) This is a tradeoff so that markdown hyperlinks work:Bonus(?): now inline code in this example is recognized: