Skip to content

Add TODO comments in the maintainers guides and update the release checklist #3724

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

Merged
seisman merged 3 commits into from
Dec 26, 2024
Merged

Add TODO comments in the maintainers guides and update the release checklist #3724

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f8e73e
Add TODO comments in the maintainers guides and update the release ch…
seisman Dec 26, 2024
4fa563a
Merge branch 'main' into doc/todo
michaelgrund Dec 26, 2024
4b74f99
Apply suggestions from code review
seisman Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
  • Loading branch information
@seisman @yvonnefroehlich
seisman and yvonnefroehlich authored Dec 26, 2024
commit 4b74f99a7a12d604d0605da390ac064191e3d1f5
5 changes: 3 additions & 2 deletions doc/maintenance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,11 @@ When making incompatible changes, we should follow the process:

To rename a function parameter, add the `@deprecate_parameter` decorator near the top
after the `@fmt_docstring` decorator but before the `@use_alias` decorator (if those two
exist). A `TODO` comment should also be added to indicate the deprecation period (see below). Here is an example:
exist). A `TODO` comment should also be added to indicate the deprecation period (see below).
Here is an example:

```python
# TODO(PyGMT>=0.6.0): Remove the deprecated `columns` parameter.
# TODO(PyGMT>=0.6.0): Remove the deprecated "columns" parameter.
@fmt_docstring
@deprecate_parameter("columns", "incols", "v0.4.0", remove_version="v0.6.0")
@use_alias(J="projection", R="region", V="verbose", i="incols")
Expand Down
Loading