convention when input can be an instance of a class
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
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.dateor :class:datetime.datetime - my_param : float or :class:
~datetime.dateor :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).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the parameter-section examples listed in the issue and determine which type and cross-reference notation numpydoc accepts. Document the chosen convention and add a corresponding example if the project’s documentation structure provides a suitable place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100