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

Remove unneeded escape sequences from documentation API signatures #4592

Closed
Gallaecio opened this issue May 22, 2020 · 2 comments · Fixed by #4596
Closed

Remove unneeded escape sequences from documentation API signatures #4592

Gallaecio opened this issue May 22, 2020 · 2 comments · Fixed by #4596

Comments

@Gallaecio
Copy link
Member

Gallaecio commented May 22, 2020

I’ve seen a few cases in the documentation like these:

.. method:: crawl(\*args, \**kwargs)
.. class:: Contract(method, \*args)
.. method:: from_crawler(crawler, \*args, \**kwargs)

The \ preceding the * does not seem necessary, and is reaching the rendered documentation.

Noticed while working on #4161.

@karsten-aichholz
Copy link

karsten-aichholz commented May 24, 2020

I'd love to give this a shot. Is it still available?

@Gallaecio
Copy link
Member Author

Gallaecio commented Jun 1, 2020

@karsten-aichholz: Sorry, @sharmarohit beat you to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants