You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
export type ApiResponse = {
/**
This pipe will not be escaped: { 'dataIDs': 'ok'|'ko' }
*/
dataIDs: { [dataId: string]: 'ok' | 'ko' }
/**
* This will be fine: { 'itemIDs': 'ok'\| 'ko' }
*/
itemIDs: { [itemId: string]: 'ok' | 'ko' }
/**
* An ugly solution: { 'userIDs': 'ok' | 'ko' }
*/
userIDs: { [userId: string]: 'ok' | 'ko' }
}
Generated markdown
The generated markdown:
| Name | Type | Description |
| :------ | :------ | :------ |
| `dataIDs` | `Object` | This pipe will not be escaped: { 'dataIDs': 'ok'|'ko' } |
| `itemIDs` | `Object` | This will be fine: { 'itemIDs': 'ok'\| 'ko' } |
| `userIDs` | `Object` | An ugly solution: { 'userIDs': 'ok' | 'ko' } |
Problem
The | char in dataIDs description is not escaped. The two next rows are shown correctly.
The | character is interpreted as the end of the row in the table
The text was updated successfully, but these errors were encountered:
Sure will have a look at escaping pipes inside comments here. Actually you have highlighted the fact the the there is no object detail - should be something like this i think...
Repro case https://github.com/roaringUnicorn/typedoc-plugin-markdown-repro
Type definition
Generated markdown
The generated markdown:
Problem
The
|
char indataIDs
description is not escaped. The two next rows are shown correctly.The
|
character is interpreted as the end of the row in the tableThe text was updated successfully, but these errors were encountered: