Skip to content

Add a changelog about the API change to objective_function in #16673#17101

Merged
pllim merged 1 commit intoastropy:mainfrom
Cadair:modeling_breaking_change
Oct 17, 2024
Merged

Add a changelog about the API change to objective_function in #16673#17101
pllim merged 1 commit intoastropy:mainfrom
Cadair:modeling_breaking_change

Conversation

@Cadair
Copy link
Member

@Cadair Cadair commented Oct 1, 2024


Description

Fixes #17085 by adding change log about #16673

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 1, 2024

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@pllim pllim added this to the v7.0.0 milestone Oct 1, 2024
@pllim pllim added Docs API change PRs and issues that change an existing API, possibly requiring a deprecation period labels Oct 1, 2024
@pllim pllim requested review from astrofrog and mcara October 1, 2024 14:11
@pllim pllim added the skip-changelog-checks Tells bot to skip changlog checks label Oct 1, 2024
@mcara
Copy link
Contributor

mcara commented Oct 1, 2024

Should examples also be updated in the docs?

@pllim pllim requested a review from WilliamJamieson October 1, 2024 14:38
@Cadair
Copy link
Member Author

Cadair commented Oct 1, 2024

I looked over the docs, and I don't think there are any examples of subclassing these non-linear fitters? We could choose to update the docs out of an abundance of caution (adding a unused **kwargs wont hurt)?

@mcara
Copy link
Contributor

mcara commented Oct 1, 2024

Also, I was just wondering (without any deep understanding) if it would be better to have a dictionary like fitter_state (or info or whatever) that would have a key fit_param_indices in it and if in the future one would like to pass extra stuff then the function signature won't change. If this is non-sense, please ignore my comment.

@Cadair
Copy link
Member Author

Cadair commented Oct 1, 2024

heh, we had that and undid it in #16982 😆

@neutrinoceros
Copy link
Contributor

@Cadair could your rebase and make sure pre-commit is happy ?

@Cadair
Copy link
Member Author

Cadair commented Oct 17, 2024

I will say it again, why can I not have the fekking github UI rebase button?

@Cadair Cadair force-pushed the modeling_breaking_change branch from e2f29c9 to 70ef97a Compare October 17, 2024 13:44
@Cadair Cadair force-pushed the modeling_breaking_change branch from 70ef97a to 7056e7c Compare October 17, 2024 13:44
@pllim
Copy link
Member

pllim commented Oct 17, 2024

Re: GitHub rebase button -- I actually think I saw it a couple of times but it is like a unicorn. I dunno what triggers its appearance.

@pllim pllim merged commit cfbd35d into astropy:main Oct 17, 2024
@pllim
Copy link
Member

pllim commented Oct 17, 2024

Thanks for your patience!

@neutrinoceros
Copy link
Contributor

it is like a unicorn

Could be a feature flag: only deployed to a sample of users at a time (and then reverted).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API change PRs and issues that change an existing API, possibly requiring a deprecation period Docs modeling skip-changelog-checks Tells bot to skip changlog checks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: TypeError: _LevMarLSQFitter2x2.objective_function() got an unexpected keyword argument 'fit_param_indices'

6 participants