Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

numpydocs: combined parameters on the same line #6

Open
erwanp opened this issue Jan 3, 2019 · 1 comment
Open

numpydocs: combined parameters on the same line #6

erwanp opened this issue Jan 3, 2019 · 1 comment

Comments

@erwanp
Copy link

erwanp commented Jan 3, 2019

Hello,

The numpy docstrings documentation states that:

When two or more input parameters have exactly the same type, shape and description, they can be combined:

x1, x2 : array_like
   Input arrays, description of `x1`, `x2`.

However, if i do that in my code...

    s1, s2: Spectrum objects
        2 spectra to compare.

... the sphinx.ext.napoleon generates the following output:

image

I assume that Napoleon is wrongly parsing the comma here. Notice also that the part after the colon disappeared.

(output available here)

@pfheatwole
Copy link

pfheatwole commented Dec 21, 2019

+1

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

No branches or pull requests

2 participants