Deprecate group() #3435
Open
Deprecate group() #3435
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
needs release notes
Contributor
|
👍 |
dstansby
force-pushed
the
deprecate-group
branch
from
9ee608b to
52f2c89
Compare
github-actions
bot
removed
the
needs release notes
# Conflicts: # docs/developers/contributing.rst # docs/quickstart.rst # docs/user-guide/groups.rst
dstansby
force-pushed
the
deprecate-group
branch
from
e7370af to
8c85c4b
Compare
github-actions
bot
added
the
needs release notes
github-actions
bot
removed
the
needs release notes
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3435 +/- ##
==========================================
- Coverage 60.90% 60.88% -0.02%
==========================================
Files 86 86
Lines 10174 10176 +2
==========================================
Hits 6196 6196
- Misses 3978 3980 +2
🚀 New features to boost your workflow:
|
d-v-b
reviewed
Jan 8, 2026
| return z | ||
|
|
||
|
|
||
| @deprecated("Use open_group() or create_group() instead") |
Contributor
There was a problem hiding this comment.
Should we state that group will be removed in a future release (3.2?)
Contributor
Author
There was a problem hiding this comment.
🤷 I'm happy either way. If you'd like me to add a specific release, let me know, and I can update the developer docs too with instructions to do this when deprecating.
d-v-b
requested changes
Jan 8, 2026
Contributor
d-v-b
left a comment
d-v-b
left a comment
There was a problem hiding this comment.
just 1 question about whether we should be more specific in the deprecation warning, otherwise looks good
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently #3406 was a bit of a tangle where
group()andcreate_group()had different behaviour - this was fixed by makinggroup()a simple wrapper ofcreate_group(), as intended.To reduce this API surface, this PR deprecates
group(), advising users to use eithercreate_group()oropen_group(). The intent of these other functions is clearer, and it mirrors the methods on theGroupclass, which does not have agroup()method.I left in one test that uses
group()to make sure it still works during the deprecation period.TODO:
docs/user-guide/*.rstchanges/