Skip to content

follow-up on Python config re-naming #60

@tomeichlersmith

Description

@tomeichlersmith

Most of the usage documentation should be updated to acknowledge the renames in LDMX-Software/ldmx-sw#1956

I do not want to replace the current camelCase variable names with the updated snake_case variable names. Instead, I would like to add notes (via admonish) warning the user about how the difference between v4.5.X (and earlier) and v4.6.X (and later) is largely a change in style of these names. Hopefully, the above PR will be quickly followed by a resolution for LDMX-Software/ldmx-sw#1303 that would prevent folks from getting more confusing errors by catching these mis-spellings on the Python side.

~~~admonish warning title="Parameter Renames"
v4.6.0 of ldmx-sw marked a change when we switched from `camelCase` style
variable names in the Python configuration modules to `snake_case`.
This change touched nearly all of the configuration classes, so care must be taken
when updating the configuration script.
~~~

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions