Experimental API for port and param docs #343
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds an optional
doc='...'
argument toself.Port(...)
,self.Parameter(...)
andself.ArgParameter(...)
. Docs are stored in the block, similar to how optional and port tags are tracked. The idea is this keeps documentation close to the port definition and (in the future) allows tools that are port-/parameter-aware to generate documentation specific to the data model here.Python doesn't have a accepted convention for class attribute docs, so we're going to make our own. PEP 224 was a proposal for attribute docstrings, but was rejected.
Quick informal conventions:
pwr
,gnd
would not need docstrings unless the docstrings add information, e.g. disambiguate between multiple power rails orpwr_in
vspwr_out
or highlight odd behavior.