Last modified: 2014-09-17 11:29:09 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T62442, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 60442 - Inconsistent arguments comment/reason/summary for edit messages
Inconsistent arguments comment/reason/summary for edit messages
Product: Pywikibot
Classification: Unclassified
General (Other open bugs)
All All
: Unprioritized enhancement
: ---
Assigned To: Pywikipedia bugs
Depends on:
Blocks: pwb20
  Show dependency treegraph
Reported: 2014-01-26 14:10 UTC by pyfisch
Modified: 2014-09-17 11:29 UTC (History)
1 user (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Description pyfisch 2014-01-26 14:10:38 UTC
When editing, deleting or protecting a page you can add a message. This message is passed to the methods of the Page object or one of its subclasses. The name of the argument is always different, when editing a page or changing a category it is "comment" when protecting, moving or deleting it is "reason". In it is always "summary", like in the MediaWiki api.

In some scripts like for example they use "editSummary" internall, eg. in

Scripts that have a commandline parameter for an edit summary (always?) call it "-summary".

I propose to change all "reason" and "comment" arguments to "summary" because this is the term used in, in script commandline parameters and by MediaWiki itself.
Comment 1 Ricordisamoa 2014-03-26 18:44:02 UTC
This messy behavior originates in the MediaWiki API:

* "reason" is used to make actions that will be logged: [[mw:API:Delete#Parameters]], [[mw:API:Protect#Parameters]], etc.
* "summary" is used when editing: [[mw:API:Edit#Parameters]]
* "comment" is used when getting data (both revisions and logs): [[mw:API:Properties#Revisions:_Parameters]], [[mw:API:Logevents#Parameters]]

Note You need to log in before you can comment on or make changes to this bug.