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

Documentation about Tables appears to be wrong #814

Open
diggidende opened this issue Sep 28, 2023 · 1 comment
Open

Documentation about Tables appears to be wrong #814

diggidende opened this issue Sep 28, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@diggidende
Copy link

diggidende commented Sep 28, 2023

Describe the gap in the current documentation

The documentation about tables suggests to use the following notation for tables with captions (see https://github.com/executablebooks/MyST-Parser/blob/master/docs/syntax/tables.md?plain=1#L40):

:::{table} Table caption
:widths: auto
:align: center

| foo | bar |
| --- | --- |
| baz | bim |
:::

But running Sphinx (with the MyST extension) to produce HTML does not produce the expected result, see screenshot (using the Furo theme):
image

After replacing the colons ::: by backticks ``` (and removing :align: center - which is the default anyways) the results look as expected:
image

Interestingly, on the same page in section 4, the documentation suggests to use backticks (rather than colons) for CSV tables, so there is some inconsistency (see https://myst-parser.readthedocs.io/en/latest/syntax/tables.html#csv-tables)

Describe the solution you'd like

Please review of the documentation of tables, and correct it where necessary.

@diggidende diggidende added the documentation Improvements or additions to documentation label Sep 28, 2023
@welcome
Copy link

welcome bot commented Sep 28, 2023

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant