niscope documentation for `fetch` and `read` does not specify what the behavior is if `num_samples` is `None`
Open
Nobody has claimed this yet.
docs
niscope
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
In niscope's fetch and read methods, num_samples = None means fetch/read all available samples. This behavior is not captured in method documentation.
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
Locate the niscope fetch and read method documentation and review how num_samples is described. Update both method descriptions to state that None fetches or reads all available samples. Done means the documented behavior matches the issue for both methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100