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

Use list tables #166

Open
christian-herber-nxp opened this issue Feb 23, 2024 · 0 comments
Open

Use list tables #166

christian-herber-nxp opened this issue Feb 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers post-v1.0 To be fixed after v1.0.0 release

Comments

@christian-herber-nxp
Copy link
Contributor

This specification has a lot of tables. They are all implemented using grid tables. This is the most powerful form of a table in restructure text, and we are not really using its features. They do have quite some disadvantages however. Most importantly, they are annoying to edit, and sometimes you are forced to completely reformat the table if something does not fit into the width of a column.
This leads to horrible difs, which make review or comparing versions difficult.

List Tables would handle this much more gracefully.

One would be able to generate the exact binary equivalent output with that directive. Reworking this is however a bit of work, maybe a smart script or an AI could do the job, but I am not aware of a working approach that doesn't require a lot of manual work.

@christian-herber-nxp christian-herber-nxp added documentation Improvements or additions to documentation good first issue Good for newcomers post-v1.0 To be fixed after v1.0.0 release labels Feb 23, 2024
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 good first issue Good for newcomers post-v1.0 To be fixed after v1.0.0 release
Projects
None yet
Development

No branches or pull requests

1 participant