In nidmm, documentation of perform_open_cable_comp() and perform_short_cable_comp() is misleading
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
The docs for nidmm.Session.perform_open_cable_comp() says to use the returned values with nidmm.Session.ConfigureOpenCableCompValues(), but that is not available in nidmm.Session....
For the NI 4082 and NI 4072 only, performs the open cable compensation measurements for the
current capacitance/inductance range, and returns open cable compensation Conductance and
Susceptance values. You can use the return values of this method as inputs to
nidmm.Session.ConfigureOpenCableCompValues()."
Thank you!
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 the nidmm.Session.perform_open_cable_comp() and nidmm.Session.perform_short_cable_comp() documentation, then inspect the referenced nidmm.Session.ConfigureOpenCableCompValues() name. Update the misleading documentation for both methods and verify that the documented API references are available and accurate.
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
- 35/100