byuccl / spydrnet

A flexible framework for analyzing and transforming FPGA netlists. Official repository.
https://byuccl.github.io/spydrnet
BSD 3-Clause "New" or "Revised" License
86 stars 20 forks source link

Add some additional information to the documentation #129

Open thunder-hammer opened 3 years ago

thunder-hammer commented 3 years ago

Clarify the difference between children and references in the definition We have the instance object defined but it may be confusing what children and references are in the context of a definition

Add some documentation about the EDIF.properties and Verilog.properties dictionaries and how those work. Additional information about the metadata would be good including which objects have it and it's intended purpose (as well as all of its potential)

jacobdbrown4 commented 3 years ago

I have added some more explanation about parents, children, and references under the page located at Reference/API Summary/Instance. I thought this would be the best place because these three things come up with instances.

jacobdbrown4 commented 1 year ago

The EDIF.properites and Verilog.properties need documentation. In reality, they need to not be seperate things but rather be a single properties dict. But for now some documentation for these would be nice.