-
-
Notifications
You must be signed in to change notification settings - Fork 974
docs(datatype): allow markdown in @see links #1667
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
docs(datatype): allow markdown in @see links #1667
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #1667 +/- ##
=======================================
Coverage 99.64% 99.64%
=======================================
Files 2240 2240
Lines 240098 240098
Branches 1068 1068
=======================================
Hits 239239 239239
Misses 838 838
Partials 21 21 |
i guess its this method? https://github.com/faker-js/faker/blob/next/scripts/apidoc/utils.ts#L114 but dont really understand what its doing or why there are two cases for a length of 1 or 3? |
previous PR where this was implemented: https://github.com/faker-js/faker/pull/1270/files |
I tried fixing the @see extraction, which works OK, although it renders like this in the docs, maybe would be better if the `` rendered as |
You probably have to call mdToHtml somewhere. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing this.
I only have some minor nitpicking, but other than that this is ready to be merged.
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
Co-authored-by: Shinigami <[email protected]>
The snapshots need updating after the last typedoc/vitepress update |
Head branch was pushed to by a user without write access
e995cf1
The PR is still failing. |
The backtick in the
@see
causes the link to get broken and the second see also not to appear:On https://next.fakerjs.dev/api/datatype.html#number
after fix: