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

Use mandatory kwargs for assert_regular_bins methods #360

Open
ajjackson opened this issue Jan 23, 2025 · 0 comments
Open

Use mandatory kwargs for assert_regular_bins methods #360

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

Comments

@ajjackson
Copy link
Collaborator

There is a slight API inconsistency between the Spectrum1D and Spectrum2D assert_regular_bins methods: if a single positional string argument is provided it could be interpreted as "message" or "bin_ax".

It's simple to fix (insert a * in the arguments list) but technically this is a breaking change so we should defer it for v2.
@ajjackson ajjackson added the breaking API-breaking or results change: generally reserved for major version number changes label Jan 23, 2025
@ajjackson ajjackson added this to the v2.0 milestone Jan 23, 2025
@ajjackson ajjackson mentioned this issue Jan 23, 2025
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