Skip to content
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

Extra spaces when merging lines in a table #331

Closed
KillyMXI opened this issue Aug 4, 2022 · 2 comments
Closed

Extra spaces when merging lines in a table #331

KillyMXI opened this issue Aug 4, 2022 · 2 comments
Labels
next Fix available in the '@next' release

Comments

@KillyMXI
Copy link

KillyMXI commented Aug 4, 2022

Updating packages:

-    "typedoc": "^0.22.15",
-    "typedoc-plugin-markdown": "^3.12.1",
+    "typedoc": "^0.23.10",
+    "typedoc-plugin-markdown": "^3.13.4",

Causes changes in generated tables:

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `column` | `number` | Column number within the line in the source string (1-based).  _(Always zero if line numbers not enabled in the lexer options.)_ |
-| `len` | `number` | The length of the matched substring.  _(Might be different from the text length in case replace value was used in a RegexRule.)_ |
-| `line` | `number` | Line number in the source string (1-based).  _(Always zero if not enabled in the lexer options.)_ |
+| `column` | `number` | Column number within the line in the source string (1-based).    _(Always zero if line numbers not enabled in the lexer options.)_ |
+| `len` | `number` | The length of the matched substring.    _(Might be different from the text length in case replace value  was used in a RegexRule.)_ |
+| `line` | `number` | Line number in the source string (1-based).    _(Always zero if not enabled in the lexer options.)_ |
 | `name` | `string` | Name of the rule produced this token. |
...

Namely, extra spaces where original type definition contained line breaks.

Previous behavior caused one extra space in case of empty line. New behavior caused 3 extra spaces in case of empty line and 1 extra space in case of line break.
Previous behavior was pretty unnoticeable. The diff drawn my attention to it and now I find 4 spaces rather annoying even though not critical.

Looks like the way comment lines are extracted is changed and now it requires more trimming.

(Side note: I'd consider an option to insert single <br> in place of empty lines to preserve content separation, but that's not essential.)

@tgreyuk
Copy link
Member

tgreyuk commented Aug 4, 2022

I'd consider an option to insert
in place of empty lines to preserve content separation

Thanks - not a bad idea i'll add to list.

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Apr 18, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

typedoc-plugin-markdown@4.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next Fix available in the '@next' release
Projects
None yet
Development

No branches or pull requests

2 participants