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
Some descriptions Test files are malformed. For example :
/**
* @file
* Contains Drupal\Component\Render\FormattableMarkup.
*/Miss a \.
core/lib/Drupal/Core/Render/Placeholder/SingleFlushStrategy.php
/**
* @file
* Contains \Drupal\Core\Render\Placeholder\SingleFlushStrategy
*/Doesn't end in a period (.)
Proposed resolution
- Add this missing \ to all
testsdefinitions - Add the missing . to the end of all @file declarations
RC Target evaluation
Only changes comments to make them consistent. Not disruptive at all.
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | interdiff-26300304-6-9.txt | 3.15 KB | marvin_B8 |
| #10 | bad_file_description-2600304-9.patch | 17.77 KB | marvin_B8 |
Comments
Comment #2
GoZ CreditAttribution: GoZ at Centarro commentedComment #3
anil280988 CreditAttribution: anil280988 at Publicis Sapient for Publicis Sapient commentedHi Goz,
4 files still remaining which still misses a \. Added a new patch which include these 4 filles.
-- a/core/modules/node/src/Tests/NodeOwnerTest.php
-- a/core/modules/system/src/Tests/Field/FieldItemTest.php
-- a/core/modules/system/src/Tests/Field/FieldItemTest.php
-- a/core/modules/system/src/Tests/Form/ElementsAccessTest.php
Comment #4
anil280988 CreditAttribution: anil280988 at Publicis Sapient for Publicis Sapient commentedChanged the status
Comment #6
marvin_B8 CreditAttribution: marvin_B8 as a volunteer and at comm-press commentedremove already fixed elements.
Comment #7
justAChris CreditAttribution: justAChris as a volunteer commentedWe should also handle the cases where the @file description does not end with a period (.) since there are only a few of those.
This grep should find those:
grep -R '* Contains \\D.*[^.]$' core/There are also cases where the namespace or classname in the description does not match the file contents, but will separate that out into a different issue.
Comment #8
justAChris CreditAttribution: justAChris as a volunteer commentedAdds an example of missing trailing period to issue summary.
Comment #9
justAChris CreditAttribution: justAChris as a volunteer commentedAnd adding rc eligible tag since this issue should only clean up documentation.
Comment #10
marvin_B8 CreditAttribution: marvin_B8 as a volunteer and at comm-press commentedComment #11
marvin_B8 CreditAttribution: marvin_B8 as a volunteer and at comm-press commentedComment #12
jhodgdonThanks!
Comment #14
xjmI used
git diff --color-wordsto confirm that this patch only adds leading slashes or periods to the@filedocblocks. Thanks for the cleanup! Committed and pushed to 8.0.x.