Skip to content

Commit

Permalink
update DEVELOPER.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli committed Aug 7, 2023
1 parent 80f714b commit 259db23
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,11 +579,11 @@ This process can be repeated periodically to stay in sync with the develop branc

## Deprecation policy

To deprecate a MODFLOW 6 option:
To deprecate a MODFLOW 6 input/output option in a DFN file:

- Add a line `deprecated x.y.z` to the option block in the appropriate DFN file, where `x.y.z` is the version the deprecation is introduced
- When support for the deprecated option is removed (typically after at least 2 minor or major releases or 1 year), add a line `removed x.y.z` to the options block, where `x.y.z` is the version support for the option was removed, and note the removal prominently in the release notes.
- Deprecated/removed options are not removed from DFN files but remain in perpetuity. The `doc/mf6io/mf6ivar/mf6ivar.py` script generates a markdown deprecation table which is converted to LaTeXi by `doc/ReleaseNotes/mk_deprecations.py` for inclusion in the MODFLOW 6 release notes.
- Add a line `deprecated x.y.z` to the option block in the appropriate DFN file, where `x.y.z` is the version the deprecation is introduced. Mention the deprecation prominently in the release notes.
- When support for the deprecated option is removed (typically after at least 2 minor or major releases or 1 year), add a line `removed x.y.z` to the options block, where `x.y.z` is the version in which support for the option was removed. Mention the removal prominently in the release notes.
- Deprecated/removed options are not removed from DFN files but remain in perpetuity. The `doc/mf6io/mf6ivar/mf6ivar.py` script generates a markdown deprecation table which is converted to LaTeX by `doc/ReleaseNotes/mk_deprecations.py` for inclusion in the MODFLOW 6 release notes. Deprecations and removals should still be mentioned separately in the release notes, however.

### Finding deprecations

Expand Down

0 comments on commit 259db23

Please sign in to comment.