nitclk usage blurb does not demonstrate how to use nitclk

Open Beginner friendly
#1,993 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

docs nitclk priority-low
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.

Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ni/nimi-python

All issues in ni/nimi-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.