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 **kwargs in docstrings #208

Merged
merged 2 commits into from
Jul 14, 2023
Merged

Fix **kwargs in docstrings #208

merged 2 commits into from
Jul 14, 2023

Conversation

A-CGray
Copy link
Member

@A-CGray A-CGray commented Jul 13, 2023

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

  • 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

@A-CGray A-CGray requested a review from a team as a code owner July 13, 2023 20:41
@codecov
Copy link

codecov bot commented Jul 13, 2023

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

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

Copy link
Contributor

@marcomangano marcomangano left a comment

Choose a reason for hiding this comment

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

I also updated the description, merging

@marcomangano marcomangano merged commit d4784ad into main Jul 14, 2023
@marcomangano marcomangano deleted the kwargDocstrings branch July 14, 2023 15:34
@ewu63
Copy link
Collaborator

ewu63 commented Jul 14, 2023

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.

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.

4 participants