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
122 stars 54 forks source link

Fix **kwargs in docstrings #208

Closed A-CGray closed 1 year ago

A-CGray commented 1 year ago

Purpose

Replaces \*\*kwargs in docstrings with \\*\\*kwargs to avoid these deprecation warnings:

/home/ali/repos/pygeo/pygeo/parameterization/DVGeoCST.py:269: DeprecationWarning: invalid escape sequence '\*'
  """

Expected time until merged

0 seconds

Type of change

Testing

Checklist

codecov[bot] commented 1 year ago

Codecov Report

Merging #208 (9408e5c) into main (d785374) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #208   +/-   ##
=======================================
  Coverage   64.76%   64.76%           
=======================================
  Files          47       47           
  Lines       12018    12018           
=======================================
  Hits         7783     7783           
  Misses       4235     4235           
Impacted Files Coverage Δ
pygeo/parameterization/DVGeoCST.py 89.34% <ø> (ø)

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

ewu63 commented 1 year ago

Wait, isn't the solution to this to use raw strings instead of escaping stuff? I.e.

r"""
**kwargs ...
"""

IMO that's way more readable than using back slashes.