Numpy docstring for fixed set of values

[pawamoy]

Discussed in mkdocstrings/mkdocstrings#617

^{Originally posted by blaylockbk September 26, 2023}
I apologize if this isn't the right place to post this (I'm just starting with mkdocstrings and am loving it! It's much easier than sphinx. Thank you).

The numpy docstring style guide says¹

When a parameter can only assume one of a fixed set of values, those values can be listed in braces, with the default appearing first:

order : {'C', 'F', 'A'}
   Description of `order`. 

So, when I document this...

Parameters
----------
order : {'C', 'F', 'A'}
    Description of `order`.
something_else : list
    Description of `something_else`.
a : int
    Description of `a`
b : str
    Description of `b`

...I expected mkdocstring to render the options for "order" in the "Type" column, but they are not rendered.

If I break away from the numpy style, I can get a list, but I'd rather follow the official numpy style.

Is this a bug in mkdocstring?

Footnotes

1. https://numpydoc.readthedocs.io/en/latest/format.html#parameters

↩