Follow up for #1648930-250: Introduce configuration schema and use for translation 11.
Namespace docs standard fix in core/lib/Drupal/Core/Config/ConfigFactory.php
Problem/Motivation
Originating issue had changes to this file, but only \namespace style fixes. It was cluttering the issue, and needed to be a separate issue.
Proposed resolution
Go through ConfigFactory.php and fix it to be correct according to http://drupal.org/node/1354#namespaces
Remaining tasks
- make initial patch of changes, keep focused on only docs and style updates. no refactoring. if refactoring is needed... make it a separate follow-up. :)
- get review
- iterate. patch, review.
Test bot coverage should be sufficient. No manual testing or screenshots needed.
User interface changes
no ui changes.
API changes
no api changes.
Comment | File | Size | Author |
---|---|---|---|
#19 | 1852272.19.patch | 696 bytes | YesCT |
#10 | ConfigFactory_docfixes-1852272-10.patch | 401 bytes | aaronott |
#6 | ConfigFactory_docfixes-1852272-6.patch | 2.28 KB | aaronott |
#4 | ConfigFactory_docfixes-1852272-4.patch | 2.43 KB | aaronott |
#2 | ConfigFactory_docfixes-1852272-2.patch | 2.26 KB | aaronott |
Comments
Comment #1
aaronott CreditAttribution: aaronott commentedThere were only two changes that I saw.
Comment #2
aaronott CreditAttribution: aaronott commentedGiven what is defined in #1 in the documentation
I've re-added all the starting backslashes to the namespaces.
This patch contains all changes from the first patch as well.
Comment #3
Lars Toomre CreditAttribution: Lars Toomre commentedThis is missing the variable name $event_dispatcher. This was an already existing error. that should be corrected in this line change.
Comment #4
aaronott CreditAttribution: aaronott commented@Lars Toomre Thanks for catching that. I've corrected that line here.
Comment #5
Lars Toomre CreditAttribution: Lars Toomre commentedYou are welcome @aaronott. The one final change that I do not think belongs in this patch is removing the blank line before the closing brace of a class declaration.
There is some uncertainty about what the Drupal standard is for class declarations and where blank lines are required. However, @tim.plunkett, @xjm and @sun have all stated that a blank line before the closing brace is part of our standards. Hence, I would leave out the removal of that blank line at the end of the patch in #4.
Comment #6
aaronott CreditAttribution: aaronott commentedInteresting I'll keep that in mind.
I've removed the removal of that blank line from patch #4.
Comment #8
YesCT CreditAttribution: YesCT commentedAn interdiff between 4 and 6 would be helpful... http://drupal.org/node/1488712
Comment #9
YesCT CreditAttribution: YesCT commented#6: ConfigFactory_docfixes-1852272-6.patch queued for re-testing.
Comment #10
aaronott CreditAttribution: aaronott commented@YesCT The interdiff looks like the following
Let me know if there is anything else. This is just adding back a blank line that I initially removed.
Comment #12
YesCT CreditAttribution: YesCT commentedTo keep the testbot from testing the interdiff file, name it something like: interdiff-4-6.txt
Re testing the patch in #6 shows it passing. (which makes more sense if the only change was adding in a line. :) )
Comment #13
Sumeet.Pareek CreditAttribution: Sumeet.Pareek commentedThis is my first day reviewing patches for Drupal and getting started (again) with contributing to Drupal here at DrupalCampDelhi - http://drupalcampdelhi.com
* This simple issue helped me learn about Doxygen comment formatting conventions for Drupal - http://drupal.org/node/1354#namespaces
* It also taught me about interdiffs - http://drupal.org/node/1488712
The patch in #6 addresses the issue. The latest patch in #10 is not the real patch but the interdiff, so I am going ahead and marking this RTBC. Thanks @aaronott and @YesCT :-)
Comment #14
Sumeet.Pareek CreditAttribution: Sumeet.Pareek commentedI remember changing the status :p
Comment #15
webchickThis patch looks great to me, but is likely to collide with #1648930: Introduce configuration schema and use for translation which is tagged as "Avoid commit conflicts." So we can commit this soon, just not right now. :)
Comment #16
YesCT CreditAttribution: YesCT commentedI remembered the reason this was split out was because it was the only change to that file and was accidentally included in the patch from that other issue.
So,
todo for me (or anyone else): check for conflicts and report back. :)
Comment #17
jhodgdonThe standard for using namespaces in docs is currently under question, so I would advise not committing this or working further on it until
#1487760: [policy, no patch] Decide on documentation standards for namespaced items
is figured out. Sigh.
Comment #17.0
jhodgdonUpdated issue summary to make it clear this is a separate issue and not a conflicting follow up
Comment #18
mgiffordThat's obsolete now I think:
https://www.drupal.org/node/1487760#comment-9138221
Comment #19
YesCT CreditAttribution: YesCT commentedThis is the only change from #10 that has not been fixed already in other issues since then.
Comment #20
YesCT CreditAttribution: YesCT commentedgiven that. I think we are ok with closing this.