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.
Problem/Motivation
The documentation is wrong for the namespace in few field formatter plugins. Ex- responsive images
Proposed resolution
Fix it
Remaining tasks
User interface changes
API changes
Beta phase evaluation
Issue category | Bug |
---|---|
Issue priority | Minor, since it's only a small documentation flaw |
Unfrozen changes | Unfrozen because it only changes documentation. |
Comment | File | Size | Author |
---|---|---|---|
#15 | wrong_documentation_for-2494551-15.patch | 732 bytes | Nitebreed |
#5 | wrong_file-2494551-5.patch | 11.17 KB | googletorp |
#5 | interdiff.txt | 7.48 KB | googletorp |
#4 | 2494551-4.patch | 3.69 KB | joshi.rohit100 |
#1 | wrong_file-2494551-1.patch | 704 bytes | googletorp |
Comments
Comment #1
googletorp CreditAttribution: googletorp at Reveal IT commentedUploaded patch.
Comment #2
joshi.rohit100I can see the same documentation problem with few other modules as well, name few - link, telephone, text..
So I think IS needs an update to accomodate these as well.
Comment #3
joshi.rohit100Comment #4
joshi.rohit100Comment #5
googletorp CreditAttribution: googletorp at Reveal IT commentedI didn't notice it was a general problem, added some more cases, you didn't find, I think we got them all now.
Comment #6
cilefen CreditAttribution: cilefen commentedIs there a way to be sure you have found all of them besides a careful visual inspection?
This is not a @file comment. Maybe the issue needs retitling.
Comment #7
googletorp CreditAttribution: googletorp at Reveal IT commentedComment #8
googletorp CreditAttribution: googletorp at Reveal IT commentedProbably not quick fix anymore.
Comment #9
cilefen CreditAttribution: cilefen commentedSomething like this could give you an idea how many could be wrong in the modules:
egrep -r '\*.*\\Drupal.*[pP]lugin' core/modules/*/src/Plugin/
Comment #10
cilefen CreditAttribution: cilefen commentedOr, you could change the issue scope back to the original @file comments and focus on them.
Comment #11
NitebreedI'm working on this issue currently at DrupalCon Barcelona together with legolasbo as my mentor.
Comment #14
attiks CreditAttribution: attiks at Attiks commentedChanged the component, since it affects multiple modules.
Comment #15
NitebreedBecause the last patch didn't apply anymore, I created a new patch that takes care of the places where the wrong namespace still existed.
Comment #16
oenie CreditAttribution: oenie commentedIt seems to me your reroll has left out a lot of changes from the patch you have rerolled.
Is that what you wanted or has it been split ?
Comment #17
NitebreedNo, those changes were already added in between the last 4 months. So the only ones left were added to the patch.
Comment #18
googletorp CreditAttribution: googletorp at Reveal IT commentedThis looks good.
A lot of the other work that was in the patch, was solved in a big fix all @file class name docs that was committed a month ago or so.
This patch addresses the rest of the incorrect documentation containing "...\field\formatter...".
So all good and RTBC imo.
Comment #19
googletorp CreditAttribution: googletorp at Reveal IT commentedComment #20
googletorp CreditAttribution: googletorp at Reveal IT commentedAdd related issue, that I was talking about in #18.
Comment #21
alexpottCommitted 872ef36 and pushed to 8.0.x. Thanks!