Skip to content

change whats new API section names #1009

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.

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

Closed
wholmgren opened this issue Jul 21, 2020 · 1 comment · Fixed by #1054
Closed

change whats new API section names #1009

wholmgren opened this issue Jul 21, 2020 · 1 comment · Fixed by #1054
Milestone

Comments

@wholmgren
Copy link
Member

I put an API change in the wrong section of the whats new file in #1008. In case it's a more common misreading, I thought I should check how other packages label these sections.

pvlib:

  • API Changes with Deprecations
  • API Changes

Pandas:

  • Backwards incompatible API changes
  • Deprecations

Numpy:

  • Expired deprecations
  • Compatibility notes
  • Deprecations
  • C API changes
  • Changes

xarray:

  • Breaking changes
  • Deprecations

For pvlib, I think xarray's pattern is most appropriate. I don't like the similarity of pvlib's sections.

@cwhanse
Copy link
Member

cwhanse commented Jul 21, 2020

I'm OK with the xarray pattern for changes to function signatures and module content.

We may want a third category, for changes which cause functions to produce different results, either from fixing bugs or changing algorithms, e.g., filtering a clearsky model for unreasonable values and replacing with NaN.

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

Successfully merging a pull request may close this issue.

2 participants