Update the index list documentation to be python-specific
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
The index list documentation for the "indices" parameter (e.g. in get_channel_names) in both nidigital and nidcpower is generic. It should be updated so that it's more helpful for a Python API.
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
Search the nidigital and nidcpower documentation for the indices parameter in get_channel_names and compare its current generic wording. Update both descriptions to explain the parameter in terms of the Python API, then verify that the documentation consistently reflects the intended usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100