Doc/overall review #240
Doc/overall review #240
Conversation
PipKat
requested review from
SMoraisAnsys,
maxcapodi78,
Samuelopez-ansys,
gmalinve and
Devin-Crawford
as code owners
github-actions
bot
added
the
documentation
|
@PipKat I'll update the changes on the notes as your changes do not allow to leverage markdown style as we used previously, for example, we would lose the "Note" section that we have currently, see below
|
|
@PipKat Thanks for this huge review, your PR greatly enhance the current documentation ! |
examples/03-high_frequency/antenna/interferences/interference_type.py
Outdated
Show resolved
Hide resolved
@SMoraisAnsys I did worry about that as working in Jupyter Notebooks is newer to me. I just assumed the indenting of the note was a formatting error (as it would be in a RST file). Sorry! |
No worries, thanks again for your huge support ! |
This PR edits examples for consistency and adherence to PyAnsys style. This review was complicated due to examples being reused in many different sections. Some comments have been left inline.
Because of the multiple levels of examples, entries are lost on the doc navigation on the left. I think I remember this happening elsewhere. It sometimes leads to you getting lost in the hierarchy. Also, sometimes third-level headings are shown and are expandable/collapsible. Other times they are not.
In some cases, files in different folders have the same name (such as antenna.py). Will file names being unique have a negative impact on search?
There are no thumbnails in the AEDT doc for the legacy PyEDB API examples. There are also no thumbnails in this repository for the Lorentz actuator and HFFS Layout UI modification examples.
Consider alphabetizing the listings in the examples that group by AEDT application.
Lastly, after headings, some examples didn't have a descriptive sentence if all there was to say was said sufficiently by the heading. I tried to remove useless sentences in later examples, but didn't notice that there were such discrepancies until midway through my review. As this repository continues to change, I suggest we remove any sentences that do not provide more information than is included in the heading.