Problem/Motivation
MigrationInterface has many left over comments from the D7 migrate module and none of it matches the coding standards.
Proposed resolution
Tidy up the comments and fix up the coding standards.
Remaining tasks
Review patch.
User interface changes
n/a
API changes
Consider removing the STATUS_* constants and maybe bringing them back in: #2289503: Track state of migrations
| Comment | File | Size | Author |
|---|---|---|---|
| #9 | 2316413-9.patch | 3.73 KB | benjy |
| #8 | interdiff.txt | 525 bytes | benjy |
| #8 | 2316413-8.patch | 234.04 KB | benjy |
| #6 | 2316413-6.patch | 3.73 KB | benjy |
| #6 | interdiff.txt | 1.47 KB | benjy |
Comments
Comment #1
chx commentedI really only have one reaction to this sort of doxygen.

(The migration is currently importing for STATUS_IMPORTING, The destination plugin for getDestinationPlugin() etc)
Comment #2
chx commentedOh well, at least phpcs is happy. I guess it's not the role of every @return to explain what's what.
Comment #3
alexpottMoving to jhodgdon's queue.
Comment #4
jhodgdonThis is pretty good... and thanks for making the patch! A few errors:
a)
been => being
b) This section seems inconsistent:
If you're going to be all verbose on the last one, be verbose on the others... or make the last one more concise? I don't think the description on Informational really makes it different from Notice either?
c)
Really? interrupted itself?... OK, but needs to end in .
d)
Also needs to end in . and can this be more consistently worded with the previous one? The other one says the process "interrupted itself" (??) and this one says it "was stopped" (seems much better). But really, what's the difference?
e)
Can this say "The ID map"?
f)
What's a highwater mark, and shouldn't it be "high water" (two words) anyway?
Comment #5
jhodgdonComment #6
benjy commentedAll fixed.
In relation to what is a high water mark.
Also, yes i think it should be two words but it's riddled throughout the codebase as one word, mainly left over from D7. Shall we do that in a follow-up?
Comment #7
jhodgdonRegarding "highwater" vs. "high water", the text you cited has it as two words. :) But I agree, the text above that in the documentation for this method has two words, so one word is fine, I guess...
The methods are also inconsistent. Some of them are CamelCased with HighWater and some with Highwater. This should all be fixed, but I agree it's a separate issue: #2320245: High water should consistently be two words -- so let's leave it as-is for now.
We should probably capitalize Unix, though? (in that same line about the high water mark). Everything else looks good; sorry for missing that last time through.
Comment #8
benjy commentedUnix capitalised. Will handle the high water stuff in the follow up later today.
Comment #9
benjy commentedOoops, branch was a bit behind. Ignore patch from #8
Comment #10
jhodgdonThanks, looks good to me!
Comment #11
jhodgdonPatch doesn't apply. Looks like the interface moved?
Comment #12
jhodgdonwait, I was trying to apply to wrong branch. :)
Committed to 8.0.x.