skywater-pdk icon indicating copy to clipboard operation
skywater-pdk copied to clipboard

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

Open pkatarzynski opened this issue 4 years ago • 5 comments

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

pkatarzynski avatar Nov 09 '20 15:11 pkatarzynski

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

pkatarzynski avatar Nov 11 '20 17:11 pkatarzynski

Doesn't https://github.com/google/skywater-pdk/pull/208 fix that?

mithro avatar Nov 13 '20 18:11 mithro

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.

pkatarzynski avatar Nov 13 '20 18:11 pkatarzynski

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

mithro avatar Nov 24 '20 19:11 mithro

Friendly ping!

mithro avatar Nov 29 '20 18:11 mithro