Skip to content

Conversation

jgd10
Copy link
Contributor

@jgd10 jgd10 commented Jun 2, 2021

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.

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
@jgd10 jgd10 requested a review from akaszynski June 2, 2021 12:37
@jgd10 jgd10 self-assigned this Jun 2, 2021
jgd10 and others added 2 commits June 2, 2021 14:14
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
@akaszynski
Copy link
Collaborator

akaszynski commented Jun 2, 2021

See https://mapdldocs.pyansys.com/contributing.html#branch-naming-conventions regarding branch names.

I'll be pushing shortly. We're missing seltol

@jgd10 jgd10 marked this pull request as draft June 2, 2021 13:47
@akaszynski
Copy link
Collaborator

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.

@akaszynski akaszynski marked this pull request as ready for review June 2, 2021 14:31
Copy link
Collaborator

@akaszynski akaszynski left a 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.

@akaszynski akaszynski merged commit 1429c5b into master Jun 3, 2021
@akaszynski akaszynski deleted the examples/jgd10 branch June 19, 2021 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants