Skip to content

Escape the * in *args and **kwargs #155

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 1, 2018
Merged

Escape the * in *args and **kwargs #155

merged 3 commits into from
Apr 1, 2018

Conversation

has2k1
Copy link
Contributor

@has2k1 has2k1 commented Jan 17, 2018

Prevents sphinx from complaining

WARNING: Inline strong start-string without end-string.

Credit: Solution taken directly from sphinx.ext.napoleon

@jnothman
Copy link
Member

I think this should be in docscrape_sphinx.py, not docscrape.py.

@has2k1
Copy link
Contributor Author

has2k1 commented Jan 17, 2018

Yes I now see the separation.

@rgommers rgommers mentioned this pull request Mar 30, 2018
Closed
@rgommers
Copy link
Member

This now conflicts with gh-144; both look good but the logic is about the same piece of code. How about merging gh-144 first, and redoing this on top of that?

This also needs a test case to prevent regressions.

@has2k1
Copy link
Contributor Author

has2k1 commented Mar 30, 2018

You can merge gh-144 and I will rebase.

@rgommers
Copy link
Member

Thanks @has2k1. gh-144 is merged now.

has2k1 added 3 commits April 1, 2018 21:43
@has2k1
Escape the * in *args and **kwargs
8fa0098 
Prevents sphinx from complaining

`WARNING: Inline strong start-string without end-string.`

Credit: Solution taken directly from sphinx.ext.napoleon
@has2k1
Move arg and kwargs escaping to docscrape_sphinx
050a6e6
@has2k1
Add tests
5a311f3
@has2k1 has2k1 force-pushed the escape-args-kwargs branch from 1f0f4f2 to 5a311f3 Compare April 1, 2018 19:15
@has2k1
Copy link
Contributor Author

has2k1 commented Apr 1, 2018

Rebased and added tests.

@rgommers rgommers modified the milestones: v0.8.0, v0.9.0 Apr 1, 2018
@rgommers rgommers merged commit 9cd5944 into numpy:master Apr 1, 2018
@rgommers
Copy link
Member

rgommers commented Apr 1, 2018

LGTM, merged. Thanks @has2k1

@larsoner larsoner mentioned this pull request Apr 11, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
type: Bug fix
Projects
None yet
Milestone
v0.9.0
Development

Successfully merging this pull request may close these issues.
4 participants
@has2k1 @jnothman @rgommers @larsoner