reset_device is functional in niswitch 1.4.9 despite docstring statement
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
The docstring for niswitch.Session() says that reset_device is not currently supported. I find that at least for the PXI-2503, reset_device=True is functional opening any relays previously closed.
Help on class Session in module niswitch.session:
class Session(_SessionBase)
| Session(resource_name, topology='Configured Topology', simulate=False, reset_device=False, *, grpc_options=None)
| | reset_device (bool): Specifies whether to reset the switch module during the initialization
| process. Valid Values: True - Reset Device (Default Value) False
| - Currently unsupported. The device will not reset.
|
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 in the niswitch.session module at the Session class and inspect the reset_device parameter docstring. Confirm the documented behavior against the issue's PXI-2503 observation, then update the documentation so it accurately describes reset_device support and verify the generated or source docstring.
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
- Mostly clear
- Newbie friendliness
- 48/100