Skip to content

Commit

Permalink
Release note for python deprecated API removal
Browse files Browse the repository at this point in the history
  • Loading branch information
Timothee Chabat committed Dec 8, 2022
1 parent e608328 commit 255d41d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Documentation/release/dev/deprecated-python-API-removal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Deprecated python API removal

Several deprecated python API that have been around for a few years are now gone.
This include :

- `paraview.simple.CreateScalarBar()`, replaced by `paraview.simple.GetScalarBar()`.
- `paraview.simple.WriteAnimation()`, replaced by `paraview.simple.SaveAnimation()`.
- `paraview.simple.WriteImage()`, replaced by `paraview.simple.SaveScreenshot()`.
- `paraview.simple.ImportCinema()`, no longer supported since 5.9.
- `paraview.compatibility.GetVersion().GetVersion()`, because of float comparison issue.

Other deprecated behaviors have been removed :

- `paraview.compatibility.GetVersion()` cannot be compared with float values anymore.
- In `paraview.simple.CreateView()`, removed support for positional argument `detachedFromLayout`.
- In `paraview.simple.SaveScreenshot()`, removed support for optional argument `ImageQuality`.
- In `paraview.simple.SaveAnimation()`, removed support for optional argument `DisconnectAndSave` and `ImageQuality`.

0 comments on commit 255d41d

Please sign in to comment.