ni / ni/nimi-python

Repeated capabilities "tip" is not useful to mere mortals

Open
#1,338 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Whenever there is a method/property that supports repeated capabilities we add the following text to the documentation:

This property can use repeated capabilities. If set or get directly on the nidigital.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling set/get value on the result.

This method requires repeated capabilities. If called directly on the niscope.Session object, then the method will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an niscope.Session repeated capabilities container, and calling this method on the result.

  • We don't say which repeated capability (channels? instruments? script_triggers? sites?) applies
  • We don't give usage example

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.

Research direction

No file or test is named, so first locate the shared documentation text for repeated capabilities and identify the affected methods and properties. Check which repeated capability applies in each case and add a relevant usage example. Done means the documentation names the capability and shows how to select or use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.