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

Add cheat sheet links in PyDPF-Core doc #468

Merged
merged 4 commits into from
Aug 23, 2023
Merged

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Aug 18, 2023

This PR adds the standard "Doc and Issues" section in the README file and overall index.rst file for the doc. It also cleans up these two pages so that they are basically consistent with the corresponding files for PyDPF-Core.

@PipKat PipKat requested review from PProfizi and anslpa August 18, 2023 16:42
@PipKat PipKat added the documentation Improvements or additions to documentation label Aug 18, 2023
@PipKat PipKat changed the title Add cheat sheet links and standard format with PyDPF-Core doc Add cheat sheet links in PyDPF-Core doc Aug 18, 2023
@codecov
Copy link

codecov bot commented Aug 18, 2023

Codecov Report

Merging #468 (fcab4b1) into master (fc5debc) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #468      +/-   ##
==========================================
- Coverage   83.53%   83.51%   -0.03%     
==========================================
  Files          45       45              
  Lines        4973     4973              
==========================================
- Hits         4154     4153       -1     
- Misses        819      820       +1     

@PipKat
Copy link
Member Author

PipKat commented Aug 21, 2023

@PProfizi This has the failed Codacy Static Code Analysis check, but all other checks have passed. Would you please review, accept, and merge? Thanks.

@PipKat
Copy link
Member Author

PipKat commented Aug 23, 2023

@ansys/pyansys-core Any chance someone could review and merge this PR? Paul P. said that a PR can be merged with this failure, but no one has reviewed and accepted it yet.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

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

LGTM.

@MaxJPRey
Copy link
Contributor

@ansys/pyansys-core Any chance someone could review and merge this PR? Paul P. said that a PR can be merged with this failure, but no one has reviewed and accepted it yet.

All good to merge @PipKat even with this failure due to indentation.
Thanks!

PipKat and others added 2 commits August 23, 2023 13:19
Make corrections from Revathy's review

Co-authored-by: Revathy Venugopal <[email protected]>
@PipKat PipKat merged commit 4334adb into master Aug 23, 2023
24 of 25 checks passed
@PipKat PipKat deleted the doc/add_cheat_sheet_links branch August 23, 2023 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants