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
The properties in MigrateException have doc comments like this:
/**
* The level of the error being reported.
*
* The value is a Migration::MESSAGE_* constant.
*
* @var int
*/
protected $level;
/**
* The status to record in the map table for the current item.
*
* The value is a MigrateMap::STATUS_* constant.
*
* @var int
*/
protected $status;
The problem is that in an IDE or on api.d.o, those don't form links.
Each of these should have a @see line added to MigrateIdMapInterface and MigrationInterface respectively.
Steps to reproduce
Proposed resolution
Remaining tasks
User interface changes
API changes
Data model changes
Release notes snippet
Issue fork drupal-3250683
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
changes
Comments
Comment #2
beatrizrodriguesI'll work on that :)
Comment #3
joachim CreditAttribution: joachim at Factorial GmbH commentedOk great!
Note that I was lazy and I didn't look up the full class names of MigrateIdMapInterface and MigrationInterface -- in the @see they need to be the namespaced class name.
Comment #4
beatrizrodriguesthanks @joachim I looked up the namespaces, but thank you for the reminder. I did the MR, I hope everything is right. Also, in the issue's description is saying that
So, I thought that the $level might have the MigrationInterface @see line, and the other, the MigrateIdMapInterface @see line. But I saw in the construct method, that was the opposite of that. I don't know if a got the description wrong or it was inverted indeed.
Comment #6
beatrizrodriguesSorry for the mess, I did the previous MR on the wrong version.
Comment #7
joachim CreditAttribution: joachim at Factorial GmbH commented> I don't know if a got the description wrong or it was inverted indeed
I got the order wrong in the issue summary, sorry!
RTBC -- the MR looks perfect. Thanks!
Comment #8
quietone CreditAttribution: quietone at PreviousNext commentedWith the suggested change the doc block has two different paths for the constants. I considered removing the sentences that start 'The value is a ...' but decided to keep them because they identify which constants are used. So, lets change those lines to point to the interface as well.
Comment #11
Tauany Bueno CreditAttribution: Tauany Bueno at CI&T commentedhey, i'll review it :)
Comment #12
Tauany Bueno CreditAttribution: Tauany Bueno at CI&T commentedHello!
I worked on the issue and fixed the problem mentioned on comment #8. Also, the MR from comment #9 removed some changes made by Beatriz that were correct.
I'm changing the status to needs review :)
ps: it needs to be rebased, however I saw that the option to rebase is available on GitLab, so I didn't work on this.
Comment #13
Tauany Bueno CreditAttribution: Tauany Bueno at CI&T commentedI committed the wrong changes for comment #8. Made a new push to fix it :)
sorry for the mess
Comment #14
Joel Guerreiro Borghi Filho CreditAttribution: Joel Guerreiro Borghi Filho at CI&T commentedHi! Will review =).
Comment #15
Joel Guerreiro Borghi Filho CreditAttribution: Joel Guerreiro Borghi Filho at CI&T commentedAfter reviewing the code and talking to @tauanygb, I checked the latest changes, and they are looking good to me. Changing status to RTBC :)
Comment #16
quietone CreditAttribution: quietone at PreviousNext commented@Joel Guerreiro Borghi Filho, thanks for commenting on what you did to decide this was RTBC.
I resolved the threads in the MR.
I should be able commit this. I'll wait 48 hours for another committer to respond.
Comment #17
alexpottCommitted and pushed 88dceab07b to 10.1.x and be7f60d445 to 10.0.x and ae4cc2e6b3 to 9.5.x and 1ee191b795 to 9.4.x. Thanks!
Backported to 9.4.x since this is a docs improvement.