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

Fixing mapdl_grpc documentation #2053

Merged
merged 10 commits into from
May 16, 2023
Merged

Fixing mapdl_grpc documentation #2053

merged 10 commits into from
May 16, 2023

Conversation

clatapie
Copy link
Contributor

@clatapie clatapie commented May 9, 2023

Closes #2052.

@clatapie clatapie requested review from germa89 and PipKat May 9, 2023 10:01
@github-actions github-actions bot added the Documentation Documentation related (improving, adding, etc) label May 9, 2023
@clatapie
Copy link
Contributor Author

clatapie commented May 9, 2023

I modified some docstrings in the of the mapdl_grpc module to align with the rest of the documentation.
Pinging @PipKat and @germa89 for visibility. Please, feel free to make any comments regarding the small changes.

@clatapie clatapie self-assigned this May 9, 2023
@codecov
Copy link

codecov bot commented May 9, 2023

Codecov Report

Merging #2053 (429361d) into main (a25fa9e) will increase coverage by 3.39%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2053      +/-   ##
==========================================
+ Coverage   82.98%   86.38%   +3.39%     
==========================================
  Files          44       45       +1     
  Lines        7932     7959      +27     
==========================================
+ Hits         6582     6875     +293     
+ Misses       1350     1084     -266     

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

LGTM.

clatapie and others added 5 commits May 10, 2023 09:54
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

src/ansys/mapdl/core/mapdl_grpc.py Outdated Show resolved Hide resolved
src/ansys/mapdl/core/mapdl_grpc.py Outdated Show resolved Hide resolved
src/ansys/mapdl/core/mapdl_grpc.py Outdated Show resolved Hide resolved
src/ansys/mapdl/core/mapdl_grpc.py Outdated Show resolved Hide resolved
src/ansys/mapdl/core/mapdl_grpc.py Outdated Show resolved Hide resolved
src/ansys/mapdl/core/mapdl_grpc.py Show resolved Hide resolved
Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

Co-authored-by: German <28149841+germa89@users.noreply.github.com>
@clatapie clatapie enabled auto-merge (squash) May 11, 2023 15:05
src/ansys/mapdl/core/mapdl_grpc.py Outdated Show resolved Hide resolved
src/ansys/mapdl/core/mapdl_grpc.py Show resolved Hide resolved
clatapie and others added 2 commits May 16, 2023 15:07
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: German <28149841+germa89@users.noreply.github.com>
@clatapie clatapie merged commit 4223fdc into main May 16, 2023
23 checks passed
@germa89 germa89 deleted the doc/mapdl_grpc_download branch May 16, 2023 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related (improving, adding, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The parameter target_dir is missing in the documentation of the function download
3 participants