Open erwanp opened 5 years ago
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`.
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:
sphinx.ext.napoleon
I assume that Napoleon is wrongly parsing the comma here. Notice also that the part after the colon disappeared.
(output available here)
+1
pfheatwole
commented
4 years ago pfheatwole
commented
4 years ago
Hello,
The numpy docstrings documentation states that:
However, if i do that in my code...
... the
sphinx.ext.napoleongenerates the following output:I assume that Napoleon is wrongly parsing the comma here. Notice also that the part after the colon disappeared.
(output available here)