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

Adjust docstrings for RST render #79

Merged
merged 1 commit into from
Mar 10, 2023
Merged

Adjust docstrings for RST render #79

merged 1 commit into from
Mar 10, 2023

Conversation

eirikurj
Copy link
Contributor

@eirikurj eirikurj commented Mar 9, 2023

Purpose

This PR fixes flake8 RST warnings, removes entries that show up as return values in documentation e.g., here, and a few typos.

Expected time until merged

1 day

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@eirikurj eirikurj requested a review from a team as a code owner March 9, 2023 11:45
@eirikurj eirikurj requested review from joanibal and sseraj March 9, 2023 11:45
@codecov
Copy link

codecov bot commented Mar 9, 2023

Codecov Report

Merging #79 (9d2d8a7) into main (d9d6191) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #79   +/-   ##
=======================================
  Coverage   73.43%   73.43%           
=======================================
  Files           6        6           
  Lines         753      753           
=======================================
  Hits          553      553           
  Misses        200      200           
Impacted Files Coverage Δ
idwarp/MultiUnstructuredMesh.py 84.61% <ø> (ø)
idwarp/UnstructuredMesh.py 62.73% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@sseraj sseraj merged commit dda9b29 into main Mar 10, 2023
@sseraj sseraj deleted the flake8rst branch March 10, 2023 14:35
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.

3 participants