Page MenuHomePhabricator

Documentation for the message Visualeditor-dialog-action-done is misleading
Closed, ResolvedPublic1 Estimated Story Points

Description

The qqq documentation for the message Visualeditor-dialog-action-done is either misleading or I misunderstand it :)

It says: "Label text for button to exit from a dialog that has no changes to make."

However, this message is used in the link inspector - this is not quite a dialog, and it does make changes.

I can think of three options:

  • I misunderstand something :)
  • This message shouldn't be used in the link inspector
  • This message's documentation should be changed

Version: unspecified
Severity: normal

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 3:43 AM
bzimport set Reference to bz70281.

... This caused T85852.

"Done" just doesn't sound like a button in a dialog that has no changes to make.

After reading @Jdforrester-WMF's reasoning on T85852 I am even more convinced that this is a problem.

UI consistency is a good idea, but enforcing too much of it is not. In particular, reusing the same message in several different dialogs is a bad idea. See
https://www.mediawiki.org/wiki/Localisation#Avoid_message_reuse

"Done" is used now in several contexts that may seem similar to developers, but are not actually the same. In Russian and Hebrew it's definitely wrong to apply the same message too all these different dialogs. As the localisation guide says, this may seem counter-intuitive, but it is also based on a lot of experience.

Change 184642 had a related patch set uploaded (by Esanders):
Create separate message for find-and-replace-done

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

Patch-For-Review

I think this is just a copy and paste error from visualeditor-dialog-action-cancel

Jdforrester-WMF renamed this task from VisualEditor: Documentation for the message Visualeditor-dialog-action-done is misleading to Documentation for the message Visualeditor-dialog-action-done is misleading.Jan 13 2015, 4:02 PM
Jdforrester-WMF assigned this task to Esanders.
Jdforrester-WMF triaged this task as Medium priority.
Jdforrester-WMF set Security to None.
Jdforrester-WMF moved this task from To Triage to Q4 on the VisualEditor board.

Change 184642 merged by jenkins-bot:
Create separate message for find-and-replace-done

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