Skip to content

Split docs/rules/layers/table-c4b-layer-description.csv#225

Open
pkatarzynski wants to merge 3 commits intogoogle:mainfrom
antmicro:144-split-table-c4b
Open

Split docs/rules/layers/table-c4b-layer-description.csv#225
pkatarzynski wants to merge 3 commits intogoogle:mainfrom
antmicro:144-split-table-c4b

Conversation

@pkatarzynski
Copy link
Copy Markdown
Contributor

@pkatarzynski pkatarzynski commented Nov 9, 2020

Tweaks the /docs/rules/layers/table-c4b-layer-description.csv table and exports the notes appended to the CSV out of the table.

Fixes #144

Signed-off-by: Piotr Katarzynski <pkatarzynski@antmicro.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 9, 2020
Copy link
Copy Markdown
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we lost a bunch of newlines?

@pkatarzynski
Copy link
Copy Markdown
Contributor Author

I removed the \n strings from the source CSV as they appeared as redundant "n" characters in the RTD table
see some descriptions in https://skywater-pdk.readthedocs.io/en/latest/rules/layers.html like areaid.hl{81:63} for instance

@mithro
Copy link
Copy Markdown
Contributor

mithro commented Nov 13, 2020

Doesn't #208 fix that?

@pkatarzynski
Copy link
Copy Markdown
Contributor Author

The script https://github.com/google/skywater-pdk/blob/master/docs/rules/periphery/periphery-split-csv.py handles periphery rules kept in a separate RST and associated CSV files. The layer rules are defined in a CSV that is explicitly included in the RST. Would it be better to make the peripherly-split-csv.py more general and re-generate the remaining rule tables from CSVs using that script?

The other approach (which I followed) assumes cleaning the source CSVs.

Copy link
Copy Markdown
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you rework this so the newlines work correctly?

@mithro
Copy link
Copy Markdown
Contributor

mithro commented Nov 24, 2020

Cleaning up the CSV file is fine, we just should clean up the CSV file by making the newlines work correctly?

@mithro
Copy link
Copy Markdown
Contributor

mithro commented Nov 29, 2020

Friendly ping!

Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
Signed-off-by: Wojciech Gryncewicz <wgryncewicz@antmicro.com>
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

Successfully merging this pull request may close these issues.

Split docs/rules/layers/table-c4b-layer-description.csv into three tables

4 participants