Skip to content

Removing v4 warnings in init and docs banner #2835

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

Draft
erikvansebille wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Removing v4 warnings in init and docs banner #2835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d7b5fa
Removing v4 warning in init
erikvansebille Aug 17, 2026
a25405a
Removing v4 warning banner on docs
erikvansebille Aug 17, 2026
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
1 change: 0 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,6 @@
"type": "fontawesome",
}
],
"announcement": "WARNING: This documentation is built for v4 of Parcels, which is unreleased and in active development. Use the version switcher in the bottom right to select your version of Parcels, or see <a href='https://docs.parcels-code.org/'>stable docs</a>.",

@VeckoTheGecko VeckoTheGecko Aug 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How about

"announcement": "Parcels v4 has been released! 🎉 See <a href='https://parcels-code.org/...'>our release blog post</a> for more info",

@VeckoTheGecko VeckoTheGecko Aug 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe it makes more sense to put the new banner in a future PR

  1. Remove warning and banner
  2. Do release
  3. Post blog post
  4. Add new banner in, which links to now posted blog post

@erikvansebille erikvansebille Aug 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yep, I was also thinking about putting a new banner up post-release

"header_links_before_dropdown": 8,
"navbar_align": "left",
}
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ filterwarnings = [
"error:.*removed in a future release of Parcels.*:DeprecationWarning", # Have Parcels DeprecationWarnings fail CI (prevents deprecated items being used in internal code)
"error:::parcels.*",
"error::UserWarning",
"ignore:This is an alpha version of Parcels v4.*:UserWarning", # TODO v4: Remove when warning is removed
]

[tool.ruff]
Expand Down
8 changes: 0 additions & 8 deletions src/parcels/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
# Local copy or not installed with setuptools.
__version__ = "unknown"

import warnings as _stdlib_warnings

from parcels._core.fieldset import FieldSet
from parcels._xarray import open_raw_zarr
from parcels._core.particleset import ParticleSet
Expand Down Expand Up @@ -82,9 +80,3 @@
# kernels
"kernels",
]

_stdlib_warnings.warn(
"This is an alpha version of Parcels v4. The API is not stable and may change without deprecation warnings.",
UserWarning,
stacklevel=2,
)