element-hq / element-hq/synapse

[2027] Remove deprecated `deactivation` flag on `set_displayname` Module API

Open
#19,546 0 comments 0 reactions 0 assignees View on GitHub
A-Modules T-Task
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

Deprecated since v1.150.0 in https://github.com/element-hq/synapse/pull/19542

Nobody is expected to be using this flag, except by accident.

We should enforce that all future arguments on this method, if any, should be kwarg-only, so that this positional argument doesn't risk being confused in the future.

Given the low pain on our side, I've set a slow removal date of 2027.

Contributor guide

Open the contributing guide

Research direction

Start by locating the set_displayname Module API and review the deprecation context in PR #19542. Confirm how the deactivation flag is currently accepted and verify that future arguments are keyword-only; done means the deprecated flag is removed without ambiguity for remaining callers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.