ni / ni/nidaqmx-python

InStream.get_channels_buffer_size should not be public

Open
#621 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

InStream.get_channels_buffer_size and OutStream.get_channels_buffer_size were intended to be internal helper methods, but they don't have a leading underscore so this makes them undocumented public APIs. We should rename them to add a leading underscore.

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

Search the repository for InStream.get_channels_buffer_size and OutStream.get_channels_buffer_size, including their call sites and tests. Rename these helper methods with leading underscores and update every reference; done means no old method names remain and the existing test suite passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.