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

Deprecation warning for \*\* in docstrings #67

Closed
ashwin153 opened this issue Jun 23, 2021 · 0 comments · Fixed by #68
Closed

Deprecation warning for \*\* in docstrings #67

ashwin153 opened this issue Jun 23, 2021 · 0 comments · Fixed by #68

Comments

@ashwin153
Copy link
Contributor

ashwin153 commented Jun 23, 2021

For example,

:param \*\*kwargs:

Causes the following deprecation warning.

DeprecationWarning: invalid escape sequence \*

Here's a reproduction.

import warnings
warnings.simplefilter("always")
x = "\*\*kwargs"
# <stdin>:1: DeprecationWarning: invalid escape sequence \*

Definitely not a pressing issue, but it pollutes my build logs. I'd suggest adding another slash (e.g., \\*). Sphinx appears to render \\* and \* the same way. For example, here's how they both render on a sample site.

kwargs

Deconstrained added a commit that referenced this issue Jun 24, 2021
Addresses #67; the double-splat escape sequence should be escaped with double-backslash.
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 a pull request may close this issue.

1 participant