Skip to content

Conversation

@quantumm
Copy link
Collaborator

Modification of the first TODO instruction that was a bit misleading for the newcomer, and could lead him to copy-paste the content of his instrument wrapper in the plugin.
The good practise is rather to lead him to import the wrapper object.

… The previous instruction was a bit misleading and lead to copy-paste the content of the wrapper file.
@quantumm quantumm requested a review from seb5g December 16, 2025 15:36
# TODO Replace this fake class with the import of the real python wrapper of your instrument
pass
# TODO Replace this fake import with the import of the real python wrapper of your instrument
from pymodaq_plugins_template.hardware.PythonWrapperFileOfYourInstrument import PythonWrapperObjectOfYourInstrument
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe say the import is not exclusive from hardware but could be from another package: pymeasure, pylablib...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for the file (module) write it in lowercase with underscore

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

pass

# TODO Replace this fake import with the import of the real python wrapper of your instrument
from pymodaq_plugins_template.hardware.PythonWrapperFileOfYourInstrument import PythonWrapperObjectOfYourInstrument
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

* consider the possibility of import from an external librairy like Pylablib or PyMeasure.
* use lower case for wrapper file name
@seb5g seb5g merged commit c90cd39 into PyMoDAQ:5.0.x Dec 17, 2025
0 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants