Fix double asterisk formatting in JSDoc #42356
Conversation
typescript-bot
added
the
For Milestone Bug
There was a problem hiding this comment.
Since you found the original reason for trailing tag parsing to start with BeginningOfLine, I think the better fix would be to switch the start state back to SawAsterisk in all cases except that one. Not sure the best way to do that -- maybe passing in initialMargin in almost all cases, or maybe adding some additional to decide what the start state should be, eg let state = isActualBeginningOfLine() ? BeginningOfLine : SawAsterisk
| @@ -129,16 129,16 @@ verify.quickInfos({ | |||
| 3: ["(parameter) param1: string", "first line of param\n\nparam information third line"], | |||
|
|
|||
| g: ["function g(param1: string): void", "This is firstLine\nThis is second Line"], | |||
| 4: ["(parameter) param1: string", "param information first line"], | |||
| 4: ["(parameter) param1: string", " param information first line"], | |||
There was a problem hiding this comment.
Notice how this tests changed. Arguably this should be the right behavior. Let me know if you think otherwise.
There was a problem hiding this comment.
Yes, I think this is a good change, because it's preserving the parent indent.
| @@ -129,16 129,16 @@ verify.quickInfos({ | |||
| 3: ["(parameter) param1: string", "first line of param\n\nparam information third line"], | |||
|
|
|||
| g: ["function g(param1: string): void", "This is firstLine\nThis is second Line"], | |||
| 4: ["(parameter) param1: string", "param information first line"], | |||
| 4: ["(parameter) param1: string", " param information first line"], | |||
There was a problem hiding this comment.
Yes, I think this is a good change, because it's preserving the parent indent.
Fixes #33386.
It has the problem that still doesn't identify when the documentation starts with a single
*. This issue already exists, and fixing it requires more thinking.Let me know if this is acceptable for now.