Skip to content

Commit 61e52ee

Browse files
waltsimsclaude
andcommitted
Use FutureWarning for legacy API deprecations
FutureWarning is shown by default; DeprecationWarning is filtered. Users need to see these warnings to migrate before 1.0. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 9e08261 commit 61e52ee

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/get_started/first_simulation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Now we combine all four components and run:
158158
``kspaceFirstOrder2D`` / ``3D`` functions. See :doc:`/get_started/new_api`
159159
for details.
160160

161-
The legacy functions still work but emit deprecation warnings.
161+
The legacy functions still work but emit warnings.
162162

163163
Step 6: Visualize Results
164164
-------------------------

docs/get_started/new_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ arguments:
134134
result = kspaceFirstOrder(kgrid, medium, source, sensor, **kwargs)
135135
136136
The legacy ``kspaceFirstOrder2D`` and ``kspaceFirstOrder3D`` functions
137-
continue to work but emit ``DeprecationWarning``.
137+
continue to work but emit ``FutureWarning``.

kwave/kspaceFirstOrder2D.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ def kspaceFirstOrder2D(
205205
"kspaceFirstOrder2D is deprecated. Use kspaceFirstOrder() from "
206206
"kwave.kspaceFirstOrder instead. See kwave.compat.options_to_kwargs() "
207207
"for migrating options.",
208-
DeprecationWarning,
208+
FutureWarning,
209209
stacklevel=2,
210210
)
211211

kwave/kspaceFirstOrder3D.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ def kspaceFirstOrder3D(
198198
"kspaceFirstOrder3D is deprecated. Use kspaceFirstOrder() from "
199199
"kwave.kspaceFirstOrder instead. See kwave.compat.options_to_kwargs() "
200200
"for migrating options.",
201-
DeprecationWarning,
201+
FutureWarning,
202202
stacklevel=2,
203203
)
204204

0 commit comments

Comments
 (0)