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

Markdown tables in @param block are replaced with 2@^5!~#sdE!_TABLE #205

Closed
nelsonni opened this issue Sep 19, 2023 · 1 comment
Closed
Labels
bug Something isn't working

Comments

@nelsonni
Copy link

nelsonni commented Sep 19, 2023

Input:

/**
 * @param options Options object for setting file system flags (default: `"r"`):
 *
 * | flags   | description                                                                                                    |
 * | ------- | -------------------------------------------------------------------------------------------------------------- |
 * | `"a"`   | Open file for appending. The file is created if it does not exist.                                             |
 * | `"ax"`  | Like `"a"` but fails if the path exists.                                                                       |
 * | `"a+"`  | Open file for reading and appending. The file is created if it does not exist.                                 |
 * | `"ax+"` | Like `"a+"` but fails if the path exists.                                                                      |
 * | `"as"`  | Open file for appending in synchronous mode. The file is created if it does not exist.                         |
 * | `"as+"` | Open file for reading and appending in synchronous mode. The file is created if it does not exist.             |
 * | `"r"`   | Open file for reading. An exception occurs if the file does not exist.                                         |
 * | `"r+"`  | Open file for reading and writing. An exception occurs if the file does not exist.                             |
 * | `"rs+"` | Open file for reading and writing in synchronous mode. Instructs the OS to bypass the local file system cache. |
 * | `"w"`   | Open file for writing. The file is created (if it does not exist) or truncated (if it exists).                 |
 * | `"wx"`  | Like `"w"` but fails if the path exists.                                                                       |
 * | `"w+"`  | Open file for reading and writing. The file is created (if it does not exist) or truncated (if it exists).     |
 * | `"wx+"` | Like `"w+"` but fails if the path exists.                                                                      |
 */

Actual result:

/**
 * @param options Options object for setting file system flags (default: `"r"`): 2@^5!~#sdE!_TABLE
 */

Expected result:

Nothing within the table should be formatted. A brief search of issues shows that code blocks and tables are supposed to be ignored:

The 2@^5!~#sdE!_TABLE text that is replacing tables within the @param field appears to come from here:

const TABLE = "2@^5!~#sdE!_TABLE";

@hosseinmd hosseinmd added the bug Something isn't working label Oct 5, 2023
hosseinmd added a commit that referenced this issue Oct 5, 2023
@hosseinmd
Copy link
Owner

fixed: v1.0.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants