Closed neil-glikin closed 1 year ago
goal: making docstrings have consistent style
Just updated first comment
from Kristian (see also #95)
It would be nice to create an empty Chamber(), then we consider the trapping potentials for the ions in IonTrap, then add the Laser and IonTrap into the Chamber.
Also: Is our convention for phrases:
with underscores, like ion_configuration
with capital letters, like IonConfiguration
with no spacing, like ionconfiguration
I've been following ion_configuration
for file names. IonConfiguration
for structs and ionconfiguration
for function names. Sometimes I break the last rule if it is not readable.
The general hope here is to make sure that use of IonSim is easy and intuitive for a user, basically matching up with intuitive expectation as best as possible. This is a list of some of my thoughts of items to consider for this. Many of them are questions about how we should handle stuff.
Julian/coding style
Specific to IonSim
set mode.N =
L.E
returns a number not a function)Chamber
first, then fill it in