-
Notifications
You must be signed in to change notification settings - Fork 28
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
Horizontal rules are removed (---
, ___
and ***
; i.e. <hr />
)
#216
Comments
Work-around: I just used a |
Add for space before dash
|
Adding the 5 spaces after the |
irahopkinson
added a commit
to paranext/paranext-core
that referenced
this issue
Nov 19, 2023
- see hosseinmd/prettier-plugin-jsdoc#216 (comment) - still doesn't show as JSDoc divider
I don't remember where it comes from. |
irahopkinson
added a commit
to paranext/paranext-core
that referenced
this issue
Nov 20, 2023
- see hosseinmd/prettier-plugin-jsdoc#216 (comment) - still doesn't show as JSDoc divider
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello! 😄 Great library! I'm loving it! 🙂
My only complaint is that it seems to remove break-lines (also known as horizontal rules).
Here's what I mean. Consider this case:
Input:
Expected:
// ... unchanged
Actual result:
The result is almost the same, except that the
---
characters have been removed!I can confirm that this occurs in both TypeScript and JavaScript files, with both types (e.g. interfaces) and runtime code (e.g. functions).
The same occurs if I try to use
***
or___
— the line gets removed.I've tried a variety of things to try to get the lines to stay, but they always seem to be removed no matter what.
This is a bit of a bummer, as I really like to use those to separate the "main" documentation from other notes, like params descriptions or defaults, or "read more" / "source" kinds of notes. I see no reason why these should be removed. They are perfectly valid syntax, and don't break any best practices, right?
Were it not for this issue, I would implement this library in all my code bases ASAP 😄
Hopefully this is fixable? 🙂 Maybe it should be a config option?
Thank you!
The text was updated successfully, but these errors were encountered: