Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Add API documentation to the Concat process plugin.
Comment | File | Size | Author |
---|---|---|---|
#14 | interdiff.txt | 550 bytes | quietone |
#14 | add_documentation_to-2845475-14.patch | 2.08 KB | quietone |
#11 | interdiff.txt | 767 bytes | quietone |
#11 | add_documentation_to-2845475-11.patch | 2.05 KB | quietone |
#9 | add_documentation_to-2845475-7.patch | 2.08 KB | quietone |
Comments
Comment #2
quietone CreditAttribution: quietone as a volunteer commentedComment #3
phenaproximaSelf-assigning for review.
Comment #4
phenaproximaCan we say "The concat process plugin is used to concatenate a set of strings", and drop "in the source"?
Let's change this to "An example use case would be imploding a set of strings into a single value."
Needs to end with a colon.
This is not accurate. It will set new_text_field to the concatenation of the 'foo' and 'bar' source values. For example, if the 'foo' property is "wambooli" and the 'bar' property is "pastafazoul", new_text_field will be "wamboolipastafazoul". Let's use a concrete example like that here.
Let's update this example for accuracy as well.
This should use {@inheritdoc}.
Comment #6
semiuniversal CreditAttribution: semiuniversal as a volunteer commentedI'll pick this up and incorporate the changes phenaproxima suggests
Comment #7
semiuniversal CreditAttribution: semiuniversal as a volunteer commentedHere's the edits.
Comment #8
quietone CreditAttribution: quietone as a volunteer commented@semiuniversal, thanks for working on this. To make this easier to review please add an interdiff in the future. The handbook has instructions for creating an interdiff.
Setting to NR for the testbot.
But the handbook states, "Use a third person verb to start the summary of a class, interface, or method. For example: "Represents a ..." or "Provides...". Which means that the summary is fine. Or do I have that wrong?
Comment #9
quietone CreditAttribution: quietone as a volunteer commentedJust trying to get the testing done.
Comment #10
phenaproximaThis is really close. Consider these nitpicks...
I'm not a huge fan of "in the source". Can we simply say "Concatenates a set of strings"?
Let's clean this up a little: "The concat plugin is used to concatenate strings. For example, imploding a set of strings into a single string."
I smile upon pastafazoul :)
Comment #11
quietone CreditAttribution: quietone as a volunteer commented1 and 2. Fixed.
3. Makes me hungry.
Comment #12
phenaproximaWorks for me.
Comment #13
cilefen CreditAttribution: cilefen commentedIn implode() and explode() terms, this should be called "glue", not "delimiter".
Comment #14
quietone CreditAttribution: quietone as a volunteer commentedHow about this, adding a reference to 'glue' at the first mention of delimiter.
Comment #15
phenaproximaI like that. I am personally in favor of "delimiter", even though the PHP documentation uses "glue". I think the word "glue" makes huge sense in the context of explaining the implode() function, but less when explaining a process plugin that wraps around it. Therefore, this is a good compromise. Combined with the excellent examples, this documentation is now crystal-clear. And I'm so pleased to be, as far as I know, the person who originally incepted the term "pastafazoul" into core.
Comment #16
cilefen CreditAttribution: cilefen commentedWe had to google "wambooli" to determine if it is an offensive word. It seems not. Pro tip: new nonsense words in core require more committer time ;-).
Comment #19
cilefen CreditAttribution: cilefen commentedCommitted 48ec916 and pushed to 8.4.x. As an API documentation improvement, it also goes in 8.3.x. Thanks!
Comment #20
cilefen CreditAttribution: cilefen commentedComment #21
phenaproximaWambooli is a nonsense word I picked up from C for Dummies, the best programming book ever written. ;-)
Comment #23
cilefen CreditAttribution: cilefen commentedWe're getting there...
Comment #24
xjm