API page: https://api.drupal.org/api/drupal/core%21modules%21views%21src%21Plugin%...
Missing @param for $type and missing @return.
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | cacheplugin_2951163_5.patch | 1.03 KB | nkoporec |
| #2 | 2951163-2.patch | 1.02 KB | parvateesam |
API page: https://api.drupal.org/api/drupal/core%21modules%21views%21src%21Plugin%...
Missing @param for $type and missing @return.
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | cacheplugin_2951163_5.patch | 1.03 KB | nkoporec |
| #2 | 2951163-2.patch | 1.02 KB | parvateesam |
Comments
Comment #2
parvateesam commentedI have added @param, @return for cacheGet() and @param for cacheSet() as well.
Comment #3
nkoporecI think there is grammar error, the sentence should be: True if data has been taken from the cache otherwise return false.
Comment #4
joachim commented> I think there is grammar error, the sentence should be: True if data has been taken from the cache otherwise return false.
I don't think we need the extra 'return' in there, but:
1. IIRC constants should be in capitals even in docs: TRUE, not true.
2. a comma would help readability.
So:
> TRUE if data has been taken from the cache, otherwise FALSE.
Comment #5
nkoporecCreated a new patch with fixed description.
Comment #6
amietpatial commented@ nkoporec Patch #5 applied successfully
Comment #7
msankhala commentedComment #8
msankhala commentedI have updated the issue title because this patch is actually fixing docblock for both
CachePluginBase::cacheGet()andCachePluginBase::cacheSet().I can confirm this patch #5 applies cleanly.
Comment #10
catchCommitted/pushed to 8.6.x and cherry-picked to 8.5.x. Thanks!