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

Update contribution.rst #1992

Merged
merged 11 commits into from
Apr 17, 2023
Merged

Update contribution.rst #1992

merged 11 commits into from
Apr 17, 2023

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Apr 14, 2023

Update the email address for support and explain how to switch to different versions of the doc.

@germa89 I talked to Roberto about making the changes that I've made in this PR before Zurich--and he agreed. I searched the PyMAPDL directory and found that the pyansy.support@pyansy.com also appears in these files:

  • In pymapdl.devcontainer\README.rst, lines 27 and 106.
  • In pymapdl\doc\source\links.rst, line 3 (although I"m not sure this reference link is used elsewhere).
  • In pymapdl\doc\source\user_guide\database.rst, line 4.
  • In pymapdl\docker\Dockerfile, line 19.

Should these email addresses also be changed to pyansys.core@pyansys.com? I could easily handle the changes myself, except maybe the first and last ones? I'm not sure if I can edit files in a devcontainer or a Dockerfile.

Also, I have no idea why my changes would reduce the code coverage by 8%. I'd love to understand why this occurred!

Update the email address for support and explain how to switch to different versions of the doc.
@PipKat PipKat requested review from germa89 and removed request for germa89 April 14, 2023 15:39
@github-actions github-actions bot added the Documentation Documentation related (improving, adding, etc) label Apr 14, 2023
@codecov
Copy link

codecov bot commented Apr 14, 2023

Codecov Report

Merging #1992 (a25fa9e) into main (f32f3c6) will decrease coverage by 3.15%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1992      +/-   ##
==========================================
- Coverage   86.12%   82.98%   -3.15%     
==========================================
  Files          44       44              
  Lines        7914     7932      +18     
==========================================
- Hits         6816     6582     -234     
- Misses       1098     1350     +252     

@germa89
Copy link
Collaborator

germa89 commented Apr 15, 2023

Hi Kathy

I'm happy with these changes.

The coverage decreases because the "local" tests fail which is supposed to increase coverage. Hence only coverage of PyMAPDL working as remote is being used. Once we rerun the test successfully, coverage should not change.

You can edit the files in devcontainer and docker directories as normal directories.

Please add the changes and I will review them

Thank you!

@germa89
Copy link
Collaborator

germa89 commented Apr 17, 2023

Regarding:

In pymapdl.devcontainer\README.rst, lines 27 and 106.

I just changed.

In pymapdl\doc\source\links.rst, line 3 (although I"m not sure this reference link is used elsewhere).

Because (I believe) this email address is going to be deprecated, I would replace this link. It is actually used but you need to look for it without the heading underscore (_). It is used in couple of places.

In pymapdl\doc\source\user_guide\database.rst, line 4.

I just changed it.

In pymapdl\docker\Dockerfile, line 19.

I just changed.

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!

doc/source/getting_started/contribution.rst Outdated Show resolved Hide resolved
@PipKat PipKat merged commit a25fa9e into main Apr 17, 2023
23 checks passed
@PipKat PipKat deleted the doc/explain_switching_doc_versions branch April 17, 2023 13:43
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.

None yet

2 participants