Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extra minor changes #345

Open
2 of 6 tasks
SMoraisAnsys opened this issue Dec 21, 2023 · 0 comments
Open
2 of 6 tasks

Extra minor changes #345

SMoraisAnsys opened this issue Dec 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@SMoraisAnsys
Copy link
Contributor

SMoraisAnsys commented Dec 21, 2023

Description of the modifications

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

@SMoraisAnsys SMoraisAnsys added the documentation Improvements or additions to documentation label Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant