Closed danhuaxu closed 2 years ago
It might be helpful to make the documentation more generic. If we are publishing this to pypi and make the repo public, the ReadMe file should not include information specific to our lab (code3 and artiq).
@danhuaxu it is good to link the issue you are addressing in the PR.
@danhuaxu also, it looks like the scope of this PR extends beyond readme updates.
For imports, my personal preference is between what @jayich suggested and what it is right now. I usually try to follow what lab members and other people typically do (e.g. import time as _t, import os). For constants and most classes it seems fine to me to import them directly though. There are certain functions that I import directly too (from functools import partial).
For modules that are imported often in Jupyter notebooks (pydux.lib.analysis.units, for example) I would recommend importing all modules as hidden, so imported modules won't pollute the autocomplete. For other modules, I dont hare a strong preference.
I'm on my home laptop and haven't used black to format the code yet. Will be in the lab and clear all the formatting tomorrow.