You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Other Parameters section in NumPy dosctrings is not rendered correctly. Here is an illustration from the standard NumPy dosctring example, where the only_seldom_used_keyword parameter is not correctly rendered in bold. Moreover the Other Parameters section should not be indented, same as Parameters or Raises.
def foo(var1, var2, *args, long_var_name="hi", only_seldom_used_keyword=0, **kwargs):
r"""Summarize the function in one line.
Several sentences providing an extended description. Refer to
variables using back-ticks, e.g. `var`.
Parameters
----------
var1 : array_like
Array_like means all those objects -- lists, nested lists, etc. --
that can be converted to an array. We can also refer to
variables like `var1`.
Other Parameters
----------------
only_seldom_used_keyword : int, optional
Infrequently used parameters can be described under this optional
section to prevent cluttering the Parameters section.
**kwargs : dict
Other infrequently used keyword arguments. Note that all keyword
arguments appearing after the first parameter specified under the
Other Parameters section, should also be described under this
section.
"""
The text was updated successfully, but these errors were encountered:
This was really the new parser not handling some of the default numpy structs correctly. This bit here:
Returns
-------
type
Explanation of anonymous return value of type ``type``.
describe : type
Explanation of return value named `describe`.
out : type
Explanation of `out`.
type_without_description
Other Parameters
----------------
The last type_without_description messed things up. I'll have to special case this. You can see it if you load it here:
Many thanks for this addition @rchiodo!
The
Other Parameters
section in NumPy dosctrings is not rendered correctly. Here is an illustration from the standard NumPy dosctring example, where theonly_seldom_used_keyword
parameter is not correctly rendered in bold. Moreover theOther Parameters
section should not be indented, same asParameters
orRaises
.The text was updated successfully, but these errors were encountered: