Document Importing/Exporting Signals
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
As per this pull request, the nimi-python APIs for several MI drivers no longer have the export_signal() function. This has led to some customer confusion, as this is a place where the Python APIs differ from the C APIs (where the corresponding ExportSignal() functions exist). Usually, if documentation doesn't exist for something in Python, users (and supporters) can reference the C or LabVIEW API and generally figure out what they need to do, but that's not the case here.
In cases like this, additional documentation noting this change and possibly showing an example of how to code the equivalent behavior should exist.
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 by reviewing pull request #848 and the documentation for the affected MI drivers. Identify where export_signal() is absent and determine how the equivalent behavior should be explained for Python users. Done means the Python/C API difference and a representative usage example are documented.
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