Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Missing space when rendering NumPy docstrings

See original GitHub issue

In NumPy-style docs such as this snippet below:

Parameters
----------
some_param : type of this parameter
    Explanation about the parameter

Spyder’s help renders the type of the parameter without any spacing from the name. Attached is a screenshot highlighting this: spyder_format

Sphinx itself adds that extra separating space, as can be seen in e.g. the official numpy docs: https://docs.scipy.org/doc/numpy-1.15.0/reference/generated/numpy.arange.html

Issue Analytics

State:
Created 4 years ago
Reactions:2
Comments:7 (4 by maintainers)

Top GitHub Comments

1reaction

ccordoba12commented, Jan 8, 2020

@dalthviz, please take care of this one as soon as you can. We need it for @juanis2112’s work on improving our docs.

1reaction

Dan-Pattersoncommented, Jul 29, 2019

Roll back to sphinx 1.8.5 I raised this issue a while ago https://github.com/spyder-ide/spyder/issues/created_by/Dan-Patterson

Top Results From Across the Web

Multi-line description of a parameter description in python ...

In practice, considering that your parameter name itself is typically a word or even longer snake_case_words , prefixed by the already lenghty <4...

pandas docstring guide - Python-Sprints

A Python docstring is a string used to document a Python module, class, ... after the name of the parameter `kind` and before...

Support for Google Style Python docstrings : PY-9795

Guys, you can start using Google and Numpy docstrings in the first PyCharm 5.0 EAP. Besides several rendering issues in the Quick Documentation...

3.2. Documenting Python APIs with Docstrings - Astro Data Lab

We use Python docstrings to create reference documentation for our Python ... For docstrings, the Numpydoc standard is to omit any space ......

How to contribute to the NumPy documentation

API reference documentation is generated directly from docstrings in the code when ... Top priority goes to technical inaccuracies – a docstring missing...