Matrix-Mirrors/mjolnir
1
0
Fork 0
mirror of https://github.com/matrix-org/mjolnir.git synced 2024-10-01 01:36:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation about what rule are removed.

Browse Source
This commit is contained in:
gnuxie 2022-02-17 10:21:56 +00:00
parent baf00e3d4b
commit 8113e048f0
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/models/BanList.ts
View File

@ -183,7 +183,8 @@ class BanList extends EventEmitter {
}
/**
* Remove all rules in the banList that would ban this entity by searching for rules that have legacy state types.
* Remove all rules in the banList for this entity that have the same state key (as when we ban them)
* by searching for rules that have legacy state types.
* @param ruleType The normalized (most recent) type for this rule e.g. `RULE_USER`.
* @param entity The entity to unban from this list.
* @returns true if any rules were removed and the entity was unbanned, otherwise false because there were no rules.