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.

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

Syntax for optional parameters not correct #9

Open
timobrembeck opened this issue Nov 26, 2020 · 0 comments · May be fixed by #10
Open

Syntax for optional parameters not correct #9

timobrembeck opened this issue Nov 26, 2020 · 0 comments · May be fixed by #10

Comments

@timobrembeck
Copy link

In your tutorial, you suggest using , optional after the parameter type to denote that a parameter is optional.
However, according to the following sources, this is not the official syntax for sphinx/reStructuredText docstrings:

Moreover, Sphinx procudes a warning when used in nit-picky mode:

WARNING: py:class reference target not found: optional

Thus, I suggest removing this syntax from the tutorial. I'm sorry if I missed any important resources.
timobrembeck added a commit to timobrembeck/Sphinx-RTD-Tutorial that referenced this issue Nov 26, 2020
@timobrembeck
Fix docstring syntax of optional parameters (fixes sglvladi#9)
fbb5b8a
@timobrembeck timobrembeck linked a pull request Nov 26, 2020 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docstring syntax of optional parameters timobrembeck/Sphinx-RTD-Tutorial
1 participant
@timobrembeck