numpydoc convention when input can be an instance of a class

[cmeeren]

For numpydoc: What is the convention for parameter type if a parameter is an instance of specific class, e.g. datetime.datetime?

Specifically, I have a parameter which can be either a float, datetime.date, or datetime.datetime. How should I write this in the parameter section?

• my_param : float or date or datetime
• my_param : float or datetime.date or datetime.datetime
• my_param : float or :class:datetime.date or :class:datetime.datetime
• my_param : float or :class:~datetime.date or :class:~datetime.datetime
• something else?

And of course, maybe a comma instead of the first "or", but that's nitpicking (which I like by the way) and not too important in this context (unless I'm mistaken).

[cmeeren]

Sorry, I don't know how this ended up in the numpy repo, I was sure I was viewing the numpydoc repo. Posted to numpy/numpydoc#43