Page MenuHomePhabricator

Document options to GlobalRenameUser::rename
Closed, ResolvedPublic

Description

GlobalRenameUser::rename takes an $options array parameter but doesn't provide a single word of documentation on what options are accepted, what types they have, what they actually do, which ones are required, etc. Reading the entire call stack is not a viable approach, so these should be documented in the method doc comment.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Change #1196677 had a related patch set uploaded (by D3r1ck01; author: Derick Alangi):

[mediawiki/extensions/CentralAuth@master] GlobalRename: Add documentation for `GlobalRenameUser::rename()`

https://gerrit.wikimedia.org/r/1196677

Change #1196677 merged by jenkins-bot:

[mediawiki/extensions/CentralAuth@master] GlobalRename: Add documentation for `GlobalRenameUser::rename()`

https://gerrit.wikimedia.org/r/1196677

Change #1196903 had a related patch set uploaded (by D3r1ck01; author: Derick Alangi):

[mediawiki/extensions/CentralAuth@master] Special: Add more docs to `GlobalRenameUser::rename()`

https://gerrit.wikimedia.org/r/1196903

Change #1196903 merged by jenkins-bot:

[mediawiki/extensions/CentralAuth@master] Replace deprecated methods on User class in SpecialGlobalRenameUser

https://gerrit.wikimedia.org/r/1196903

matmarex assigned this task to DAlangi_WMF.
matmarex removed a project: Patch-For-Review.