Refactor to add underscores to method names #35
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* `initprop` → `init_prop` * `propstep!` → `prop_step!` * `reinitprop!` → `reinit_prop!` * `getcontrolderiv` → `get_control_deriv` * `getcontrolderivs` → `get_control_derivs` * `getcontrols` → `get_controls` The old names were based on the Julia Style Guide recommendation to name methods with "multiple words squashed together". I've come to regard this as a very bad idea. To quote the JuMP style guide, "This convention creates the potential for unnecessary bikeshedding and also forces the user to recall the presence/absence of an underscore, e.g., "was that argument named basename or base_name?". For consistency, always use underscores in variable names and function names to separate words.
goerz
added a commit
to JuliaQuantumControl/GRAPELinesearchAnalysis.jl
that referenced
this pull request
Nov 12, 2022
goerz
added a commit
to JuliaQuantumControl/Krotov.jl
that referenced
this pull request
Nov 12, 2022
goerz
added a commit
to JuliaQuantumControl/GRAPE.jl
that referenced
this pull request
Nov 12, 2022
goerz
added a commit
to JuliaQuantumControl/QuantumControl.jl
that referenced
this pull request
Nov 12, 2022
* `initprop` → `init_prop` * `propstep!` → `prop_step!` * `reinitprop!` → `reinit_prop!` * `getcontrolderiv` → `get_control_deriv` * `getcontrolderivs` → `get_control_derivs` * `getcontrols` → `get_controls` JuliaQuantumControl/QuantumPropagators.jl#35 JuliaQuantumControl/QuantumControlBase.jl#48
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
initprop→init_proppropstep!→prop_step!reinitprop!→reinit_prop!getcontrolderiv→get_control_derivgetcontrolderivs→get_control_derivsgetcontrols→get_controlsThe old names were based on the Julia Style Guide recommendation to name methods with "multiple words squashed together". I've come to regard this as a very bad idea. To quote the JuMP style guide, "This convention creates the potential for unnecessary bikeshedding and also forces the user to recall the presence/absence of an underscore, e.g., "was that argument named basename or base_name?". For consistency, always use underscores in variable names and function names to separate words.