Adjust docstrings for RST render - Githubissues

mdolab / idwarp

IDWarp is a mesh warping package for the MACH framework.

Other

17 stars 29 forks source link

Adjust docstrings for RST render #79

Closed eirikurj closed 1 year ago

eirikurj commented 1 year ago

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)
[x] 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

codecov[bot] commented 1 year ago

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% <ø> (ø)`

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