vtr-verilog-to-routing icon indicating copy to clipboard operation
vtr-verilog-to-routing copied to clipboard

VTR flow library documentation is just a skeleton -- should fill in

Open vaughnbetz opened this issue 2 years ago • 0 comments

https://docs.verilogtorouting.org/en/latest/vtr/python_libs/vtr/ has the skeleton of documentation for this library, but only the headings are there.

Proposed Behaviour

Complete the documentation

Context

Our flow scripts are pretty complex (and useful) so documenting them is helpful. We do have pretty reasonable documentation on the overall scripts, so if you conclude no documentation is needed on the library you could instead delete this documentation tab. But I suspect documentation here will be useful.

vaughnbetz avatar Jun 09 '22 15:06 vaughnbetz