Page MenuHomePhabricator

Step 1: finalize edit flow name (impact: medium)
Closed, ResolvedPublic3 Estimated Story Points

Description

Problem:
The “overwrite” edit flow name does not accurately describe the currently implemented edit flow: it matches the “replace” edit decision (the old value is overwritten), but not the “update” one (the old value stays in place and a new one is added to the same statement group in order to amend it). [Terminology note: the “edit flow” is declared on the bridge link, whereas the “edit decision” is made by the user.] We want to change it before the first templates have to be adjusted, so that people don’t have to change the templates several times.

Acceptance criteria:

  • The edit flow is instead named single-best-value.
  • At this stage, we don’t need backwards compatibility. We don’t support “overwrite” at all anymore.
  • Adjust all of our showcase pages to use the new edit flow name (including test and showcase).
  • Adjust documentation (DocDraft).

Notes:

  • While the name single-best-value implies that multiple statements can be applicable for Bridge if only one of them has preferred rank, this logic is currently not implemented in Bridge. Bridge only supports single statements so far and will only support that in Step 1.

Event Timeline

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

Notes from discussion with Lydia:

Anticipating that the current edit flow (with the edit decisions to replace the current value, or to update it with a new preferred value) will be expanded with the capability to edit more than one statement, as long as exactly one of them is best (i. e., preferred rank, or normal rank if all others are deprecated), we suggest a name along the lines of “single best value”. This describes the invariant of the data, so to speak: this edit flow can operate on any statement group (selected by entity and property ID) which contains a single best value (editing that value), and either edit decision of this edit flow preserves that characteristic – either the single best statement has had its value replaced, or there is a new single best statement and the previous one has been demoted to non-best status. (This demotion need not include an actual change to its rank if it was previously the only normal-rank statement.)

The contrasting edit flow we envision is something like “multiple best values” or “multiple values”, which would be suitable for e. g. someone’s children: you have a list of equally-ranked values (we’re having trouble imagining a scenario where different non-deprecated ranks would still be used), and they remain equally-ranked afterwards, no matter whether you’ve added another value, replaced one of the existing values, or even removed some of the existing values. (That is not to say that the implementation of that edit flow would offer all those capabilities; this is vague and fuzzy, at least to me.)

@Lydia_Pintscher does this still belong in the “Needs work” column? As far as I’m aware, the decision is basically done, except for some bikeshedding over whether we prefer “single best value”, “single-best-value”, “singlebestvalue”, “singleBestValue” etc.

@Lydia_Pintscher does this still belong in the “Needs work” column? As far as I’m aware, the decision is basically done, except for some bikeshedding over whether we prefer “single best value”, “single-best-value”, “singlebestvalue”, “singleBestValue” etc.

Rationale during story writing: “single best value” looks like a list of independent values (compare class=""). “singlebestvalue” is needlessly unreadable. “single-best-value” is preferred over “singleBestValue” because it matches the attribute name (data-bridge-edit-flow, not dataBridgeEditFlow).

Lydia_Pintscher set the point value for this task to 3.

Discussion from task break-down:

  • "search and replace" pretty much
    • there is many repetitions of the (old) value in browser tests even though there is but one valid value currently - reconsider if it makes sense to keep it that way or move a default value into DataBridgePage.createInfoboxWikitext()

Change 592990 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/extensions/Wikibase@master] bridge: rename overwrite to single-best-value

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

Change 592990 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] bridge: rename overwrite to single-best-value

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

I did a few more searches on-wiki, and I think all the pages are now updated (except for Data-bridge-test-page talk pages on Beta Wikidata – updating those seems unnecessary).

Maybe @Lydia_Pintscher wants to reviewverify this and run it by some users.