Allow @see to pass markdown links as is. Close #52. #60
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
|
Would be great to have tests for this as well |
|
I'll do what i can to add test. Do you have some requests on what test to add ? I've already updated the main function-tags test. |
|
Hi, i've added some functionnal tests and enhanced the @see functionnality to detect URL in text, and added a basic support for paths starting by '/', './' and '../'. |
|
@landure Hey! Thank you for all your contributions, I've merged all of your PRs. |
landure
added a commit
to landure/shdoc
that referenced
this pull request
Aug 17, 2023
…uest#60) * Allow @see to pass markdown links as is. Close reconquest#52. * Enhance @see functionnality with URL detection and add functionnal tests. Co-authored-by: Egor Kovetskiy <e.kovetskiy@gmail.com>
landure
added a commit
to landure/shdoc
that referenced
this pull request
Aug 17, 2023
…uest#60) * Allow @see to pass markdown links as is. Close reconquest#52. * Enhance @see functionnality with URL detection and add functionnal tests. Co-authored-by: Egor Kovetskiy <e.kovetskiy@gmail.com>
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.
This modification detect is @see contains a markdown link (
[]()) and pass the content as is if it is the case.This close #52 and allow to use HTTP(S) URLs in @see.
I've updated the readme, the example file and unit tests.