ni / ni/nidaqmx-python

Audit function parameter names

Open
#25 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api enhancement
Dominant language
Python
Stars
592
Forks
199
Avg merge
1d 16h
Merged PRs (30d)
10

Description

Python supports named parameters and would ideally be used in long lists by add channel.

Changing a parameter name will break compatibility though. We should audit to ensure the parameter names are things that we want.

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 files, tests, or specific entry points are identified. Start by locating public functions with long parameter lists, especially those used to add channels, and audit their parameter names for consistency and suitability for named arguments. Treat compatibility impact as part of the review; done means the desired naming changes and affected compatibility concerns are identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.