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

Adding /FCLEAN implementation #1633

Merged
merged 1 commit into from
Nov 21, 2022
Merged

Adding /FCLEAN implementation #1633

merged 1 commit into from
Nov 21, 2022

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Nov 17, 2022

Closes #1606

@germa89 germa89 added the Enhancement Improve any current implemented feature label Nov 17, 2022
@github-actions github-actions bot added the New Feature Request or proposal for a new feature label Nov 17, 2022
@github-actions
Copy link
Contributor

Please add one of the following labels to add this contribution to the Release Notes 👇

@germa89
Copy link
Collaborator Author

germa89 commented Nov 17, 2022

Requesting @clatapie to review this PR.

This is a classic example on how to add a new MAPDL function to PyMAPDL. As you see it is very simple procedure.

Just need to add the function to the correspondent python file. You can find out by checking the APDL command reference guide:

image

If you see this command is categorized as Session > Files (see yellow highlight), so we look for this file in the repo and it is here pymapdl/src/ansys/mapdl/core/_commands/session/files.py.

Then you just need to copy the body of the command description and adapt it to the RST requirements. Including any parameter (in this case there is none), outputs (none again), etc.
More details about the format of this docstring can be find in: https://numpydoc.readthedocs.io/en/latest/format.html
And an example in: https://numpydoc.readthedocs.io/en/latest/example.html

@codecov
Copy link

codecov bot commented Nov 17, 2022

Codecov Report

Merging #1633 (b88cea7) into main (fb5fb8b) will increase coverage by 3.30%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1633      +/-   ##
==========================================
+ Coverage   79.51%   82.81%   +3.30%     
==========================================
  Files          44       44              
  Lines        7151     7151              
==========================================
+ Hits         5686     5922     +236     
+ Misses       1465     1229     -236     

@germa89
Copy link
Collaborator Author

germa89 commented Nov 17, 2022

Pinging @maromer0 for learning purposes.

This is a classic (and very simple) example on how to write docstrings for later being able to be rendered by Sphinx. Please have a look.

@germa89 germa89 self-assigned this Nov 17, 2022
Copy link
Contributor

@clatapie clatapie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took notes of this example, thank you @germa89 !

@germa89 germa89 merged commit 2170cc1 into main Nov 21, 2022
@germa89 germa89 deleted the feat/implement-fclean branch November 21, 2022 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Improve any current implemented feature New Feature Request or proposal for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement /FCLEAN
2 participants