We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Here is an example in marshmallow docs: https://marshmallow.readthedocs.io/en/stable/marshmallow.validate.html
Take the first And class as an example. Here is the raw definition:
And
And(*validators: Callable[[Any], Any], error: Optional[str] = None)
Expected output:
And(*validators, error)
Actual output:
And(*validators, Any], error)
It seems that Sphinx uses the comma to separate the arguments, but it can't tell if the comma is in the arguments list or in the type annotations.
$ git clone https://github.com/marshmallow-code/marshmallow $ cd marshmallow $ pip install tox $ tox -e docs $ # open _build/html/marshmallow.validate.html
No response
https://github.com/marshmallow-code/marshmallow
Source: https://github.com/marshmallow-code/marshmallow/blob/dev/docs/marshmallow.validate.rst Doc: https://marshmallow.readthedocs.io/en/stable/marshmallow.validate.html
macOS Big Sur 11.4
3.8
4.1.2
The text was updated successfully, but these errors were encountered:
Fix sphinx-doc#9600: autosummary: Typehints including commas confuses…
ed3cc81
… autosummary
0a8655b
Merge pull request #9606 from tk0miya/9600_typehints_including_commas
a3f08fe
Fix #9600: autosummary: Typehints including commas confuses autosummary
No branches or pull requests
Describe the bug
Here is an example in marshmallow docs: https://marshmallow.readthedocs.io/en/stable/marshmallow.validate.html
Take the first
And
class as an example. Here is the raw definition:Expected output:
Actual output:
It seems that Sphinx uses the comma to separate the arguments, but it can't tell if the comma is in the arguments list or in the type annotations.
How to Reproduce
Expected behavior
No response
Your project
https://github.com/marshmallow-code/marshmallow
Screenshots
Source: https://github.com/marshmallow-code/marshmallow/blob/dev/docs/marshmallow.validate.rst
Doc: https://marshmallow.readthedocs.io/en/stable/marshmallow.validate.html
OS
macOS Big Sur 11.4
Python version
3.8
Sphinx version
4.1.2
Sphinx extensions
No response
Extra tools
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: