Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adaptive broadening API tweaks: Euphonic v2 #249

Open
ajjackson opened this issue Oct 27, 2022 · 0 comments
Open

Adaptive broadening API tweaks: Euphonic v2 #249

ajjackson opened this issue Oct 27, 2022 · 0 comments
Labels
breaking API-breaking or results change: generally reserved for major version number changes
Milestone
v2.0

Comments

@ajjackson
Copy link
Collaborator

As discussed in #245

  • --energy-broadening option in Euphonic v1.0 has an ambiguous/dual-mode usage depending on the adaptive broadening mode. This is resolved by supplementing with more precise --adaptive-scale and --instrument-broadening options, but --energy-broadening is really a better and more consistent name for the behaviour.

For Euphonic 2.0:

  • Drop the complicated logic, make --energy-broadening an alias to --instrument-broadening
  • Add a DeprecationWarning to --instrument-broadening, recommending use of --energy-broadening

For Euphonic 3.0:

  • Drop the --instrument-broadening alias
@ajjackson ajjackson added the breaking API-breaking or results change: generally reserved for major version number changes label Oct 27, 2022
@ajjackson ajjackson added this to the v2.0 milestone Oct 27, 2022
@ajjackson ajjackson mentioned this issue Oct 27, 2022
Open
@ajjackson ajjackson mentioned this issue Sep 6, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
breaking API-breaking or results change: generally reserved for major version number changes
Projects
None yet
Milestone
v2.0
Development

No branches or pull requests
1 participant
@ajjackson