The general hope here is to make sure that use of IonSim is easy and intuitive for a u

Resources <a href="https://docs.julialang.org/en/v1/manual/style-gui

from Kristian (see also <a class="issue-link js-issue-link" data-error-text="Failed to

Also: Is our convention for phrases: <div class="snippet-clipboard-content notrans

Style/Consistency Checks about ionsim.jl HOT 7 CLOSED

haeffnerlab commented on June 12, 2024

Style/Consistency Checks

from ionsim.jl.

Comments (7)

neil-glikin commented on June 12, 2024 1

Just updated first comment

from ionsim.jl.

marwahaha commented on June 12, 2024

goal: making docstrings have consistent style

from ionsim.jl.

neil-glikin commented on June 12, 2024

Resources

https://docs.julialang.org/en/v1/manual/style-guide/
https://github.com/invenia/BlueStyle

from ionsim.jl.

marwahaha commented on June 12, 2024

https://github.com/domluna/JuliaFormatter.jl (?)

from ionsim.jl.

marwahaha commented on June 12, 2024

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.

from ionsim.jl.

marwahaha commented on June 12, 2024

Also: Is our convention for phrases:

with underscores, like ion_configuration
with capital letters, like IonConfiguration
with no spacing, like ionconfiguration

from ionsim.jl.

jbroz11 commented on June 12, 2024

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.

from ionsim.jl.

Recommend Projects