Documentation for iterable properties and method parameters should mention "iterable" instead of "list"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
Some properties and method parameters are designed to work with iterables. e.g.:
https://github.com/ni/nimi-python/blob/8540e86f00dc4b7aa9dbf5d905275db7255d9c7b/generated/nidigital/nidigital/session.py#L607
offsets can be any iterable object. But the documentation says:
offsets (list of float in seconds or datetime.timedelta):
We should update the documentation, in all such cases, to say something like "iterable of float in seconds...".
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 generated/nidigital/nidigital/session.py around line 607 and inspect how the offsets parameter is documented. Search the generated API documentation for other parameters and properties described as lists even though they accept iterables. Update those descriptions to use iterable wording, then verify that all such cases are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100