spydrnet icon indicating copy to clipboard operation
spydrnet copied to clipboard

Add some additional information to the documentation

Open thunder-hammer opened this issue 3 years ago • 2 comments

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)

thunder-hammer avatar Apr 30 '21 16:04 thunder-hammer

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 avatar May 18 '21 19:05 jacobdbrown4

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.

jacobdbrown4 avatar Apr 26 '23 19:04 jacobdbrown4