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.

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

docs: add deprecation policy to dev docs and release guide #1889

Merged
merged 1 commit into from
Aug 2, 2023

Conversation

wpbonelli
Copy link
Member

@wpbonelli wpbonelli commented Aug 1, 2023

Add deprecation guidelines after discussion with @langevin-usgs, @jdhughes-usgs, @mjreno. Followup to #1878.

  • describe policy loosely following NEP 23 in
    • DEVELOPER.md
    • docs/make_release.md
  • update table of contents in DEVELOPER.md
  • fix some autotest names

PRs applying deprecations introduced in version 3.3.5 or before:

* describe deprecation policy loosely following NEP 23
* fix some autotest names per pending deprecations
@wpbonelli wpbonelli requested a review from mwtoews August 1, 2023 18:52
@codecov
Copy link

codecov bot commented Aug 1, 2023

Codecov Report

Merging #1889 (6094575) into develop (70b9a37) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           develop   #1889   +/-   ##
=======================================
  Coverage     72.2%   72.2%           
=======================================
  Files          257     257           
  Lines        56488   56488           
=======================================
  Hits         40836   40836           
  Misses       15652   15652           

@wpbonelli wpbonelli marked this pull request as ready for review August 1, 2023 19:05
Copy link
Contributor

@mwtoews mwtoews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I'm aware of NEP 23 and think it is a good inspiration for a deprecation policy.

Would some recent deprecations (e.g. here) be modified that they are anticipated to be changed for FloPy 3.7?

@wpbonelli
Copy link
Member Author

wpbonelli commented Aug 2, 2023

Thanks @mwtoews would you suggest correcting anticipated removal version numbers, or removing/omitting them? Looks like numpy does not include them in their sample warning messages, I guess they are inherently a bit speculative.

@wpbonelli wpbonelli merged commit 0c5f143 into modflowpy:develop Aug 2, 2023
@wpbonelli wpbonelli deleted the dep-doc branch August 2, 2023 16:11
@mwtoews
Copy link
Contributor

mwtoews commented Aug 2, 2023

Thanks, I see that only the version the feature was deprecated should be specified, but the exact removal version does not need to be specified. It is also not possible to accurately "guess" if the +2 versions from now would be (e.g.) 3.6.0 or 4.0.0.

Lets leave the existing deprecation messages alone for now, but going forward only specify the version they were deprecated.

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

Successfully merging this pull request may close these issues.

3 participants