Docs show optionals as required

[lalalune]

[AqeelAqeel]

docs/batch_rendering.md

arguments / docstring is where we're supposed to read this in for MKDocs. might be reading it in incorectly.

Will keep looking / reviewing MK Docs more

[lalalune]

mkdocstrings/griffe#165

Seems like we need to structure it like this

class Example(NamedTuple):
"""A simple example of the autorefs bug

Parameters
----------
required : int
    A required value
optional : float, optional
    An optional value, default is -3.6
"""

[pawamoy]

In the screenshot above, it looks like you're using the Google-style for docstrings. Just remove the dashes in front of parameter names and it should work as expected.

Otherwise, yes, you can also switch to the Numpydoc-style if this is what you prefer :)

[lalalune]

In the screenshot above, it looks like you're using the Google-style for docstrings. Just remove the dashes in front of parameter names and it should work as expected.

Otherwise, yes, you can also switch to the Numpydoc-style if this is what you prefer :)

Thank you, very useful