Skip to content

[DOC] Star symbols (*) are escaped in docs signatures. #17119

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
Closed
ImportanceOfBeingErnest opened this issue Apr 13, 2020 · 1 comment · Fixed by #17120
Closed

[DOC] Star symbols (*) are escaped in docs signatures. #17119

ImportanceOfBeingErnest opened this issue Apr 13, 2020 · 1 comment · Fixed by #17120
Labels
Documentation
Milestone
v3.2-doc

Comments

@ImportanceOfBeingErnest
Copy link
Member

Bug report

In the current docs, the signatures render with star symbols/asterix being escaped, like

suptitle(self, t, \*\*kwargs)

e.g.
image
matplotlib.figure.Figure.suptitle

Matplotlib version

  • Matplotlib version: current docs / devdocs
@anntzer
Copy link
Contributor

anntzer commented Apr 13, 2020

I think this is numpy/numpydoc#256; see as to how skimage fixed that.

Merged
6 tasks
@QuLogic QuLogic added this to the 3.2-doc milestone Apr 13, 2020
@brunobeltran brunobeltran mentioned this issue Apr 20, 2020
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.2-doc
Development

Successfully merging a pull request may close this issue.

[DOC] strip_signature_backslash matplotlib/matplotlib
3 participants
@QuLogic @anntzer @ImportanceOfBeingErnest