-
Notifications
You must be signed in to change notification settings - Fork 139
Added examples to multiple commands #465
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
Conversation
Added examples to commands based on the lectures 1-6 in the MAPDL lecture course. The commands have been converted to pymapdl from raw APDL. They have not been tested where the commands obviously line-up with what they should be
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
See https://mapdldocs.pyansys.com/contributing.html#branch-naming-conventions regarding branch names. I'll be pushing shortly. We're missing |
Noticing there's a ton of inline comments in these examples. According to PEP8 Inline Comments, they should be used sparingly. Since they're not rendered in the examples, I'm going to move them out when applicable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Reminder that inline comments should be avoided in the Examples
section within numpydoc. Sphinx will render text outside >>>
as plain text, which is quite readable in the autogenerated docs.
Added examples to commands based on the lectures 1-6 in the MAPDL
lecture course. The commands have been converted to pymapdl from raw
APDL. They have not been tested where the commands obviously line-up
with what they should be (they all follow what the documentation says
they should do, so they should work fine).
This PR is based on lectures 1-6. There are 21 lectures in total and I am slowly
working through them all. Do not delete this branch as I will use it for future
PRs on the same topic.