search

PowerBroker2 / pySerialTransfer

Python package to transfer data in a fast, reliable, and packetized form
MIT License
145 stars 35 forks source link

Remove unused functions from `pySerialTransfer.py` #88

Closed robberwick closed 6 months ago

robberwick commented 7 months ago

The msb, lsb, and open_ports functions are unused and can be removed from pySerialTransfer.py

Addresses #87

PowerBroker2 commented 7 months ago

These may not be used by the library itself, but I do feel they are useful tools. I'd prefer to keep them as long as they don't cause issues with other parts of the library.

robberwick commented 7 months ago

well that's certainly reasonable. In the case of the msb and lsb functions perhaps if they were moved to a utilities or helpers module and commented as such, there would be less expectation that they were used as part of the core functionality?

In the case of the open_ports function, that seems to be entirely replicating the functionality of the serial_ports function which uses the tools provided by pyserial directly. It seems suboptimal to maintain both, so perhaps open_ports could be removed? Or, if you think it is in use, then it could be retained, but act simply as a proxy to serial_ports, and be commented as deprecated? or vice versa, of course.

robberwick commented 6 months ago

Just checking on what you felt about the suggestion above? if you're happy with that, i'll go ahead and make the changes.

PowerBroker2 commented 6 months ago

After thinking about it, I'm ok with removing these functions