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

MAINT: improve examples #609

Merged
merged 34 commits into from
Nov 17, 2022
Merged

MAINT: improve examples #609

merged 34 commits into from
Nov 17, 2022

Conversation

GuillemBarroso
Copy link
Contributor

Improvements in the example section.

  • Several modifications in the examples descriptions to fix typos, class and function paths and to rewrite some sentences.
  • Addition of absolute and relative error plots when two fields are compared.
  • Addition of line plot when mapping field to a path.

@PProfizi, @MaxJPRey, feedback will be greatly appreciated.

@GuillemBarroso GuillemBarroso added documentation Improvements or additions to documentation examples Related to PyDPF-Core examples labels Nov 9, 2022
@codecov
Copy link

codecov bot commented Nov 9, 2022

Codecov Report

Merging #609 (7fac551) into master (be8d22d) will increase coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #609      +/-   ##
==========================================
+ Coverage   87.90%   88.02%   +0.11%     
==========================================
  Files          68       69       +1     
  Lines        7566     7623      +57     
==========================================
+ Hits         6651     6710      +59     
+ Misses        915      913       -2     

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
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.

Thanks @GuillemBarroso for taking time to review and work with all those examples.

@PProfizi
Copy link
Contributor

@GuillemBarroso For the last Codacy warning remaining, I am basing my fix on this page: https://security.openstack.org/guidelines/dg_use-subprocess-securely.html

@GuillemBarroso
Copy link
Contributor Author

@GuillemBarroso For the last Codacy warning remaining, I am basing my fix on this page: https://security.openstack.org/guidelines/dg_use-subprocess-securely.html

Great, thanks @PProfizi. I am rerunning the only check that failed and as soon as it passes, we can merge.

@@ -1,3 +1,4 @@
# noqa: D400
Copy link
Contributor

Choose a reason for hiding this comment

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

@GuillemBarroso What is that skipping for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

D400 indicates that the first line should end with a period, see doc.

@PProfizi, as we discussed, I will add the rule of ignoring D400 for the examples in the next PR, when I update the layout of the repo and I add the pre-commit.

@PProfizi PProfizi merged commit fbe7103 into master Nov 17, 2022
@PProfizi PProfizi deleted the maint/improve-examples branch November 17, 2022 10:13
@GuillemBarroso GuillemBarroso self-assigned this Nov 29, 2022
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 examples Related to PyDPF-Core examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants