ZCode: On creating converter, show warning if we detect a Z0 is being written to communicate it will be replaced
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	gengh
	Jun 20 2024, 4:38 PM

Description

On code converter create pages:

The function is initiated with name and arguments set to Z0. The persistence layer replaces these with the newly created Zid.

If the editor adds the substring "Z0" inside the code expecting it to remain that way, this will fail, as every Z0 will be replaced, not only function and argument names.

Desired behavior/Acceptance criteria

When the code includes a Z0 inside a string, show a warning message stating that every Z0 substring will be replaced.

Completion checklist

Before closing this task, review one by one the checklist available here: https://www.mediawiki.org/wiki/Abstract_Wikipedia_team/Definition_of_Done#Front-end_Task/Bug_Completion_Checklist

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Add notice message about Z0 Placeholder in Converter	mediawiki/extensions/WikiLambda	master	+65 -4

Customize query in gerrit

Event Timeline

gengh created this task.Jun 20 2024, 4:38 PM

Jdforrester-WMF triaged this task as Low priority.Jun 26 2024, 4:54 PM

Jdforrester-WMF moved this task from To Triage to Backlog on the Abstract Wikipedia team board.

DSmit-WMF subscribed.Aug 21 2024, 2:25 PM

This comment was removed by DSmit-WMF.

Change #1064737 had a related patch set uploaded (by Daphne Smit; author: Daphne Smit):

[mediawiki/extensions/WikiLambda@master] [WIP] ZSerialiser and ZDeserialiser Validation: Add Warning for Z0 Placeholder in Converter

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

gerritbot added a project: Patch-For-Review.Aug 22 2024, 11:59 AM

DSmit-WMF changed the task status from Open to In Progress.Aug 22 2024, 2:15 PM

DSmit-WMF claimed this task.

DSmit-WMF moved this task from Backlog to 25Q1 (Jul–Sep) on the Abstract Wikipedia team board.Aug 23 2024, 8:57 AM

DSmit-WMF edited projects, added Abstract Wikipedia team (25Q1 (Jul–Sep)); removed Abstract Wikipedia team.

DSmit-WMF moved this task from Incoming to In Progress on the Abstract Wikipedia team (25Q1 (Jul–Sep)) board.

would it be possible to display the warning* more contextually? eg. above or below the code editor

or maybe, what if we display this as a temporary inline comment?

CleanShot 2024-09-02 at 16.20.02@2x.png (1×3 px, 326 KB)

*is it correct to consider this as a warning message, or if it's more a FYI type of thing?

@AAlhazwani-WMF would it then be okay to display this warning from the start and not after some event? The warning would be always visible in the case of creating a converter.

Regarding the possible designs, I think I like the second and the third more than the warning!!

Jdforrester-WMF moved this task from 25Q1 (Jul–Sep) to 25Q2 (Oct–Dec) on the Abstract Wikipedia team board.Sep 25 2024, 7:24 PM

Jdforrester-WMF edited projects, added Abstract Wikipedia team (25Q2 (Oct–Dec)); removed Abstract Wikipedia team (25Q1 (Jul–Sep)).

Jdforrester-WMF moved this task from Incoming to In Design review on the Abstract Wikipedia team (25Q2 (Oct–Dec)) board.

after chatting with @gengh we landed on

Every 'Z0' occurrence will be replaced with a system-generated ID in your code upon publishing.

Change #1064737 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] Add notice message about Z0 Placeholder in Converter

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

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.28; 2024-10-22).Oct 15 2024, 2:00 PM

Maintenance_bot removed a project: Patch-For-Review.Oct 15 2024, 2:31 PM

Jdforrester-WMF moved this task from In Design review to Ready to deploy on the Abstract Wikipedia team (25Q2 (Oct–Dec)) board.Oct 16 2024, 4:39 PM

Jdforrester-WMF moved this task from Ready to deploy to Needs Sign-off on the Abstract Wikipedia team (25Q2 (Oct–Dec)) board.Oct 28 2024, 1:24 PM

Jdforrester-WMF closed this task as Resolved.Oct 30 2024, 2:09 PM

	F57406815: CleanShot 2024-09-02 at 16.20.02@2x.png
	Sep 2 2024, 2:22 PM

	F57612904: image.png
	Oct 14 2024, 10:54 AM

ZCode: On creating converter, show warning if we detect a Z0 is being written to communicate it will be replacedClosed, ResolvedPublicActions

Description

Description

Completion checklist

Details

Event Timeline

ZCode: On creating converter, show warning if we detect a Z0 is being written to communicate it will be replaced
Closed, ResolvedPublic
Actions