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
There are some Schema functions that don't have the doc comment in the concrete classes but the documentation is in the abstract class \Drupal\Core\Database\Schema.
Proposed resolution
Add the
/**
* {@inheritdoc}
*/
bloc comment to the functions
Remaining tasks
None.
User interface changes
None.
API changes
None.
Data model changes
None.
Comment | File | Size | Author |
---|---|---|---|
#7 | add_inheritdoc_function_doc_comment_to_schema_classes-2863750-2.patch | 17.27 KB | tstoeckler |
Comments
Comment #2
adriancidComment #3
joe_carvajalSeems to be OK. This way these methods can inherit the doc from Drupal\Core\Database\Schema.
Thank you for reporting it!
Comment #4
joe_carvajalComment #5
daffie CreditAttribution: daffie commented+1 RTBC
Can be removed on commit: 2 trailing whitespaces.
Comment #6
alexpottComment #7
tstoecklerLiterally removed the spaces from the patch file. Seems unnecessary to bother committers with this for a docs patch.
Comment #9
tim.plunkettRe-RTBCing for the nitfix
Comment #12
xjmSo, normally, we require fixing a single rule or sub-rule across all of core in a single issue. However, fixing
Drupal.Commenting.ClassComment.Missing
is going to be massive (#2571965: [meta] Fix PHP coding standards in core says there were 161 of them a year-and-some ago), and in many cases adding new documentation requires actually writing documentation. In this case we have a lot of known offenders concentrated in one namespace with the same fix pretty much everywhere in the namespace, so I think it makes sense to fix these as scoped. All we have to do is confirm that these methods do exist on the parent class and are being inherited.Committed to 8.5.x, and cherry-picked to 8.4.x as a documentation addition. Thanks!
Comment #13
tim.plunkett@adriancid congrats on your first core commit credit!
Comment #14
adriancidThanks @tim.plunkett I hope that this is just the begining :-D