Docstring Style: Add Examples about pyaedt HOT 5 CLOSED

@maxcapodi78, please let me know your thoughts regarding this.

from pyaedt.

I think you are right. but here we have almost 2000 docstrings and converting evertything could be huge work. If the end results in sphinx is the same I would probably stay on the traditional python docstrings

from pyaedt.

I think you are right. but here we have almost 2000 docstrings and converting evertything could be huge work. If the end results in sphinx is the same I would probably stay on the traditional python docstrings

Would indeed be a lot of work. However, since we're already lacking good Example portions of the docstrings, it might be something we can do over a series of PRs.

Working on the docs is a good way to learn the package. I'll probably do this once AEDT is installed on my machine.

from pyaedt.

Nice work with d8b3fda. Still need to add examples, so I'm leaving this open and self-assigning.

from pyaedt.

Closing as we're mostly there. Still tracking as a project.

from pyaedt.