Problem/Motivation
The following methods in \Drupal\views\Plugin\views\display\DisplayPluginInterface are not documented:
- initDisplay
- destroy
Proposed resolution
Add docblocks for the mentioned methods.
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | missing-docblocks-2585979-10.patch | 951 bytes | nicrodgers |
| #5 | interdiff-1-5.txt | 817 bytes | sdstyles |
| #5 | missing-docblocks-2585979-5.patch | 922 bytes | sdstyles |
| #2 | missing-docblocks-2585979-1.patch | 945 bytes | vdanielpop |
Comments
Comment #2
vdanielpop commentedComment #3
vdanielpop commentedComment #4
jhodgdonThanks for filing this issue and making a patch! It's almost perfect; just needs a small amount of work:
Initialize => Initializes
This looks like a typo.
@return should not be indented like this, and there is an additional * on the line.
Also there should be a blank line between the @param section and the @return
And the return value needs to be documented. What is returned from this method?
Comment #5
sdstyles commentedI removed @return because &$display is passed as reference, and all initDisplay() methods don't return anything.
Comment #6
jhodgdonAgreed, that method does not return anything. And given that, removing the @return is correct.
The new patch looks great! Thanks!
Comment #7
alexpottThe param description should be preceded with
(optional)and prefixed withDefaults to NULL..Comment #8
alexpottAs this is a documentation change it is rc eligilbe
Comment #9
snehi commented+1 for RTBC
Comment #10
nicrodgersUpdated based on feedback in #7
Comment #11
jhodgdonThanks!
Interdiff files are always appreciated, for the next time...
Comment #12
alexpottCommitted 0a9d46f and pushed to 8.0.x. Thanks!