Page MenuHomePhabricator

discussiontoolssubscribe api should not reuse discussiontoolsedit api documentation for commentname
Closed, ResolvedPublicBUG REPORT

Description

As a user
When I go to https://meta.wikimedia.beta.wmflabs.org/w/api.php?action=help&modules=discussiontoolssubscribe
And I read the documentation of the "commentname" parameter

Actual result:
"Name of the comment to reply to. Only used when paction is addcomment. This parameter is required."

Expected result:
"paction" is not a part of this api module, its from action=discussiontoolsedit. It shouldn't be mentioned here. This api module doesn't add replies, its for topic subscriptions. The issue comes from trying to reuse the same documentation message (apihelp-discussiontoolsedit-param-commentname) from the other api module, instead of adding a new message that actually explains how the parameter is used in this module.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
DannyS712 changed the subtype of this task from "Task" to "Bug Report".
DannyS712 added subscribers: ppelberg, Esanders.
ppelberg moved this task from Backlog to Triaged on the DiscussionTools board.

Triaging as low considering we are not yet prioritizing work on supporting third-party useres of the API.

Change 714401 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/extensions/DiscussionTools@master] Improve discussiontoolssubscribe API documentation

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

Change 714401 merged by jenkins-bot:

[mediawiki/extensions/DiscussionTools@master] Improve discussiontoolssubscribe API documentation

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

matmarex claimed this task.