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

General edit of Krylov example #1605

Merged
merged 11 commits into from
Nov 3, 2022
Merged

General edit of Krylov example #1605

merged 11 commits into from
Nov 3, 2022

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Nov 1, 2022

Here's the edited file. I'm going to leave a few comments/questions. Note that the existing Examples section needs to be reworked to following Google developer style guidelines. If you want to see better examples, look at those for PyAEDT. I also want to talk to German about breaking out the example sections in separate RST files so that the TOC for this section makes more sense.

@PipKat PipKat requested a review from kmkoshy November 1, 2022 19:55
@github-actions github-actions bot added the Documentation Documentation related (improving, adding, etc) label Nov 1, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2022

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

@codecov
Copy link

codecov bot commented Nov 1, 2022

Codecov Report

Merging #1605 (ac128f5) into main (09d8436) will increase coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1605      +/-   ##
==========================================
+ Coverage   82.71%   82.82%   +0.11%     
==========================================
  Files          44       44              
  Lines        7143     7151       +8     
==========================================
+ Hits         5908     5923      +15     
+ Misses       1235     1228       -7     

@kmkoshy kmkoshy requested a review from germa89 November 2, 2022 09:52
@kmkoshy
Copy link
Contributor

kmkoshy commented Nov 2, 2022

Here's the edited file. I'm going to leave a few comments/questions. Note that the existing Examples section needs to be reworked to following Google developer style guidelines. If you want to see better examples, look at those for PyAEDT. I also want to talk to German about breaking out the example sections in separate RST files so that the TOC for this section makes more sense.

Thanks so much for the review @PipKat

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.

Minor suggestions, but it looks good to me.

@germa89
Copy link
Collaborator

germa89 commented Nov 2, 2022

German about breaking out the example sections in separate RST files so that the TOC for this section makes more sense.

I'm happy to meet you anytime @PipKat :)

@ansys ansys deleted a comment from germa89 Nov 2, 2022
@ansys ansys deleted a comment from germa89 Nov 2, 2022
PipKat and others added 3 commits November 2, 2022 10:06
Add German's review comments

Co-authored-by: German <28149841+germa89@users.noreply.github.com>
@germa89 germa89 merged commit f6c5882 into main Nov 3, 2022
@germa89 germa89 deleted the docs/edit_Kylov_example branch November 3, 2022 09: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.

None yet

3 participants