Open Deckstar opened 11 months ago
Work-around: I just used a ~-~
as a divider and that was retained, however although that gives the space it doesn't show as a divider.
Add for space before dash like:
export interface Props {
/**
* The target element.
*
* ---
*
* Some more notes here.
*
* @default window
*/
target?: Node | Window;
}
Adding the 5 spaces after the *
and before the ---
does allow it to be retained, however it still doesn't show as a JSDoc divider. Please re-open this issue.
I don't remember where it comes from.
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:
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!