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.
Add documentation comments to the views access plugins as described in #1882558: [META] Document all views plugins types.
Beta phase evaluation
Issue category | Task because we are adding more detail to the documentation of AccessPluginBase. |
---|---|
Issue priority | Normal because this change is has no widespread impact. |
Unfrozen changes | Unfrozen because it only changes the ViewsAccessPlugin documentation. |
Prioritized changes | None |
Disruption | None |
Comment | File | Size | Author |
---|---|---|---|
#15 | interdif-15.txt | 704 bytes | joshi.rohit100 |
#15 | revised-views-access-plugins-1912658-15.patch | 1.16 KB | joshi.rohit100 |
#7 | revised-views-access-plugins-1912658-7.patch | 1.16 KB | mikebell_ |
#3 | revised-views-access-plugins-1912658-3.patch | 1.2 KB | zealfire |
#1 | document-views-access-base-plugin-1912658-1.patch | 1.36 KB | thsutton |
Comments
Comment #1
thsutton CreditAttribution: thsutton commentedAdd details to the documentation block for
AccessPluginBase
.Comment #2
dawehnerBeside this small thing below, I'm wondering whether it makes sense to provide an example here for the access/get_access_callback methods.
The middle sentence is confusing, as it is 100% out of context :)
Comment #3
zealfire CreditAttribution: zealfire commentedSince, this issue has remained inactive for a long time period i have decided to work on it.Is it fine? Also i am submitting a new patch but still not sure whether we need to add example for access method.Please review.
Thanks.
Comment #4
dawehnerAlways!
IMHO instead of given an example you could also just point to a congrete instance.
Comment #5
meramo CreditAttribution: meramo as a volunteer and at Bright Solutions GmbH commentedStill applies, however I think that having two comment blocks stacked one after another might not be a good idea, provided they're explaining the same thing basically. May be the first one should go to the @file section?
Comment #6
Anonymous (not verified) CreditAttribution: Anonymous at XIO commentedWhile I get this, I find it a bit confusing. Some rewording could help.
Missing a space after the dot.
Judging from the example, this one is optional?
I'm not entirely sure, but I think those follow a guideline and should be left as-is.
Comment #7
mikebell_ CreditAttribution: mikebell_ as a volunteer commentedI've fixed the minor formatting issues and removed short title since it's optional.
I get what your saying regarding the first lines so I added a bit more text and move the second sentence to it's own line. It flows a lot cleaner now.
Comment #8
isholgueras CreditAttribution: isholgueras commentedComment #14
Anonymous (not verified) CreditAttribution: Anonymous at XIO commentedOh yes, this is way clearer to me.
Only a nitpick left:
user's?
Comment #15
joshi.rohit100Comment #16
Anonymous (not verified) CreditAttribution: Anonymous at XIO commentedLooks good to me. Added a beta eval.
Comment #17
alexpottCommitted f2c047c and pushed to 8.0.x. Thanks!