Fixed
Project:
Drupal core
Version:
main
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
31 Aug 2026 at 09:20 UTC
Updated:
15 Oct 2026 at 22:12 UTC
Jump to comment: Most recent
Comments
Comment #4
rsanjuan commentedFixed typo in StaticMap boolean documentation. ALTIA linked.
Comment #5
dcam commentedThank you for your work on this issue. I noticed additional problems that are tightly coupled to this issue and I believe should be solved in conjunction with the current fix.
"foo" and "bar" are both overloaded strings in the Boolean example. I don't like it. This isn't the only place where it occurs in these docs. The
default_valueexample also overloads "bar". It looks like the top/basic example has been copied and pasted several times and the author(s) never realized "foo" and "bar" are already in use. This is inappropriate in general, but especially for a system where the names of data fields are being referenced.Top/basic example:
We should expand the scope here to remove the overloading of "foo" and "bar" within the individual examples. I suggest that "foo" and "bar" should only be used for the source and destination field names, respectively. Anything else should be changed to alternate metasyntactic variables or something else entirely. For instance in the case of the Boolean example:
In that case, the explanatory text already being edited in the MR should be updated with the new values.
Comment #7
ishfaqafridi85 commentedUpdated MR !16970 to address the review in comment #5.
default_value: barexample todefault_value: fallbackand updated its explanation.0: bazand1: quxand updated the explanation so the field namesfoo/barare no longer reused as mapped values.Pipeline 973264 has unrelated failures in existing PHP 8.6 deprecation tests and the Nightwatch jQuery UI position shim test; retries produced the same failures. This change does not touch those tests or runtime code.
Comment #8
dcam commentedThank you for making those changes. Let's send it up.
Comment #9
benjifisher@dcam, thanks for expanding the scope (Comment #5). I completely agree that we should not use the (source and destination) variable names as the values. Personally, I would use something like "vanilla" and "chocolate" as the values, or "blue" and "green", but I will not argue with "alternate metasyntactic variables".
As a nod to my friend Guy Steele, I have to insist on the correct spelling: "quux", not "qux". So I am setting the status back to NW.
From the Wikipedia page on Metasyntactic variables, I see that both are in use. Searching the Drupal codebase, I see that "qux" is used more than "quux". But I am one of the maintainers of the migration subsystem, so I think I can insist on which one to use in the
migratemodule.Comment #10
ishfaqafridi85 commentedUpdated MR !16970 to address the feedback in comment #9. The Boolean mapping example and its accompanying explanation now use `quux` instead of `qux`, as requested. Thank you for the review and clarification.
Comment #11
ishfaqafridi85 commentedUpdated the change based on the maintainer’s feedback.
The requested
quuxterminology is now used consistently.This is ready for review.
Comment #12
ishfaqafridi85 commentedComment #13
dcam commentedLooks good.
I updated the issue title and summary with the expanded scope.
Comment #14
benjifisherishfaqafridi85: Thanks for indulging me.
dcam: Thanks for updating the issue summary.
+1 for RTBC
Comment #15
quietone commentedComment #21
quietone commentedThanks for improving the documentation!
Committed and pushed to all branches as a documentation improvements are an allowed change,