You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A few points to consider to consolidate the documentation:
In the right pane of the documentation, there are three entries across instead of all entries horizontally. It's hard to use the navigation pane. You also can't collapse or expand items. What is the use of the check box ?
There are a few missing docstrings, especially in the terminals module of the API section..
It might be worth to change the release notes / changelog position which is currently at the end of the API reference section. Proposed change would be to reference it in the README.md and reuse it in the doc landing page.
Verify the capitalization of "Stride" model. Currently, the initial letter is capitalized but perhaps it should be "STRIDE"?
In the Utilities section of the API, the PortPostProcessingProp class is missing data typing in the attributes. This is one missing in the Value class too. (In the file's first sentence, there is a random period that needs to be removed so that the example given is tagged as a code entity: (such as**.**w1 + w2``).
In the Definitions section of the API, there are lots of formatting issues for these methods: Jedec5BondwireDef.get_parameters() and PadstackDefData.get_hole_parameters(). On further exploration, these formatting issues exist in all places where list entries were used to document values of a tuple. I think putting them as their own lines, with a blank line in between, will need to be done to fix the issues.) Additionally, in PackageDef, this text is formatted as a link but it doesn't work :class:`Database <ansys.edb.core.database.Database>.
Useful links and references
No response
The text was updated successfully, but these errors were encountered:
Description of the modifications
A few points to consider to consolidate the documentation:
(such as**.**
w1 + w2``).Jedec5BondwireDef.get_parameters()
andPadstackDefData.get_hole_parameters()
. On further exploration, these formatting issues exist in all places where list entries were used to document values of a tuple. I think putting them as their own lines, with a blank line in between, will need to be done to fix the issues.) Additionally, in PackageDef, this text is formatted as a link but it doesn't work:class:`Database <ansys.edb.core.database.Database>
.Useful links and references
No response
The text was updated successfully, but these errors were encountered: