nitclk usage blurb does not demonstrate how to use nitclk
Open
Beginner friendly
Nobody has claimed this yet.
docs
nitclk
priority-low
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
nitclk_usage.inc is essentially empty. It does not demonstrate how to use the API.
We do have an example that it links to, so it's a minor issue. We could steal from that to create a proper blurb.
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 docs/_static/nitclk_usage.inc and compare it with src/nitclk/examples/nitclk_niscope_synchronize_with_trigger.py, which the blurb links to. Adapt the example into a concise API usage demonstration, then verify that the generated documentation shows a useful nitclk example rather than an empty section.
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
- 68/100