mdolab / pygeo

pyGeo provides geometric design variables and constraints suitable for gradient-based optimization.
https://mdolab-pygeo.readthedocs-hosted.com/en/latest/?badge=latest
Apache License 2.0
124 stars 55 forks source link

fix some docstrings #162

Closed ewu63 closed 1 year ago

ewu63 commented 1 year ago

Purpose

I cleaned up the docs a bit and fixed some docstrings/RST problems.

Expected time until merged

Soon

Type of change

Testing

Checklist

codecov[bot] commented 1 year ago

Codecov Report

Merging #162 (8edbe4b) into main (bb27e51) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #162   +/-   ##
=======================================
  Coverage   63.93%   63.93%           
=======================================
  Files          47       47           
  Lines       11819    11819           
=======================================
  Hits         7556     7556           
  Misses       4263     4263           
Impacted Files Coverage Δ
pygeo/constraints/DVCon.py 71.72% <ø> (ø)
pygeo/constraints/curvatureConstraint.py 87.73% <ø> (ø)
pygeo/geo_utils/ffd_generation.py 83.89% <ø> (ø)
pygeo/geo_utils/pointselect.py 7.14% <ø> (ø)
pygeo/parameterization/BaseDVGeo.py 70.00% <ø> (ø)
pygeo/parameterization/DVGeo.py 66.35% <ø> (ø)
pygeo/parameterization/DVGeoAxi.py 77.21% <ø> (ø)
pygeo/parameterization/DVGeoCST.py 88.78% <ø> (ø)
pygeo/parameterization/DVGeoESP.py 64.88% <ø> (ø)
pygeo/parameterization/DVGeoMulti.py 89.77% <ø> (ø)
... and 4 more

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