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

Fix failing doctests #3123

Merged
merged 1 commit into from
Jul 9, 2023
Merged

Conversation

agriyakhetarpal
Copy link
Member

Description

A quick fix after #3074 and #3097 to declare the inheritance_diagram.py extension safe for parallel reads and writes, in order to suppress warnings that arise when running the doctests in the CI which are treated as errors.

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all
  • The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link

codecov bot commented Jul 8, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (5486fce) 99.71% compared to head (59fa13d) 99.71%.

❗ Current head 59fa13d differs from pull request most recent head beddc27. Consider uploading reports for the commit beddc27 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3123   +/-   ##
========================================
  Coverage    99.71%   99.71%           
========================================
  Files          248      248           
  Lines        18747    18747           
========================================
  Hits         18693    18693           
  Misses          54       54           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@agriyakhetarpal
Copy link
Member Author

@Saransh-cpp Saransh-cpp self-requested a review July 8, 2023 15:37
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

Thanks for the fix, @agriyakhetarpal! :)

@Saransh-cpp Saransh-cpp merged commit f389db2 into pybamm-team:develop Jul 9, 2023
20 of 24 checks passed
@agriyakhetarpal agriyakhetarpal deleted the fix-doctests branch July 14, 2023 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants