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
@webchick pointed out in that all the constants introduced for #2120003: [META] Create sensible limits for the maximum length of configuration object filename components are a little confusing, and the docs could be made more explicit to clarify what the different parts of the filename are and why the various values were chosen.
Proposed resolution
Improve the docs for all the relevant contstants with more detailed explanation and @see to other relevant constants.
|\ _,,,---,,_
/,`.-'`' -. ;-;;,_
|,4- ) )-,_..;\ ( `'-'
'---''(_/--' `-'\_)
Comment | File | Size | Author |
---|---|---|---|
#13 | interdiff.txt | 1.29 KB | xjm |
#13 | config-docs-2229931-13.patch | 3.59 KB | xjm |
#12 | interdiff.txt | 1.19 KB | xjm |
#12 | config-docs-2229931-12.patch | 3.6 KB | xjm |
#10 | interdiff.txt | 992 bytes | xjm |
Comments
Comment #1
xjmComment #2
xjmOops, should be getConfigPrefix().
Not rerolling until someone else reviews. ;)
Comment #3
xjm...And this should be "namespace identifiers if desired" to match the words we used earlier in the docblock.
Comment #4
jhodgdonThe explanations seem understandable to me. A few formatting nitpicks:
a) This is not going to format well on api.drupal.org:
It doesn't support number/letter lists, only bullets with - ... so this will format as all one jumbled-up paragraph. Not too great...
b) Also getConfigPrefix should probably end in () -- I assume it's a method on this class?
c) And one of those lines in there is missing a * at the start.
d)
Why the \ here? If this is just a constant defined in an include file, I think we should just leave off the \ ?
Comment #5
jhodgdonComment #6
jhodgdonAlso, is it bytes or characters?
Comment #7
xjmThanks! It's characters. I'll reroll to fix the formatting once someone else who's worked on these issues can review it.
Comment #8
BerdirDocumentation looks correct to me, can RTBC when the wording/formatting stuff is fixed.
Comment #9
xjmHere we go. Also added an @see to the constant from #1709960: declare a maximum length for entity and bundle machine names.
Comment #10
xjmOne additional clarification.
Comment #11
BerdirI think all feedback has been addressed, looks correct, so RTBC.
Comment #12
xjmTwo more teensy fixes (a space and a typo, so leaving RTBC).
Comment #13
xjmSigh, and more whitespace. Clearly have lost my touch.
Comment #15
jhodgdonLatest patch looks good. How about if I just commit it? OK. :) Done!