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

Some of the tables of arguments are too complex to be represented by GFM #533

Closed
atusy opened this issue Mar 28, 2022 · 0 comments · Fixed by #534
Closed

Some of the tables of arguments are too complex to be represented by GFM #533

atusy opened this issue Mar 28, 2022 · 0 comments · Fixed by #534

Comments

@atusy
Copy link
Contributor

atusy commented Mar 28, 2022

As @eitsupi has raised issue in REditorSupport/vscode-R#927 , there are some cases where Arguments become VS Code ignores the section if the section remains to be an HTML table due to its complex content. See details in the link.

To avoid this, we need to convert the table to some alternative format.
I would suggest the following style.

### Arguments

#### `Arg1`:

Description of  Arg1

#### `Arg2`:

Description of Arg2.

This may contain multiple paragraphs.

- and some list

or

```
code blocks
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant