Documentation fore "return type" of nidigital fetch_capture_waveform method is unclear
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
In the documentation for the fetch_capture_waveform method of nidigital, "Return type" is listed as "{ int: memoryview of array.array of unsigned int, int: memoryview of array.array of unsigned int, … }".
This is extremely confusing and gives almost no indication of how to interpret the return type, other than it being a key-value pair.
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 fetch_capture_waveform documentation linked in the issue and inspect how its return type is currently presented. Update the documentation so the key-value mapping and memoryview values are understandable, with completion marked by a clear explanation of how to interpret the returned data.
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