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 API documentation to the SkipRowifNotSet process plugin.
Comment | File | Size | Author |
---|---|---|---|
#8 | 2845492.patch | 1.7 KB | FJ7 |
#3 | 2845492-3.patch | 2.07 KB | quietone |
#2 | 2845492-1.patch | 0 bytes | quietone |
Comments
Comment #2
quietone CreditAttribution: quietone as a volunteer commentedComment #3
quietone CreditAttribution: quietone as a volunteer commentedComment #5
phenaproximaSelf-assigning for review.
Comment #7
phenaproximaLet's rephrase this: "If the value is set, it is returned. Otherwise, a MigrateSkipRowException is thrown."
Should end with a colon.
This should be "The source property to check for."
Should end with a colon.
This should have an explanation afterwards to demonstrate what output would be expected.
This should be {@inheritdoc}.
Comment #8
FJ7 CreditAttribution: FJ7 commentedComment #9
phenaproximaThere's a little extra white space on the blank line above the comment, but that can be fixed on commit.
Otherwise, looks good. RTBC from me on the assumption that the tests will pass.
Comment #10
alexpottWhy are we removing the link - it is still valid no?
Comment #11
phenaproximaWe discussed this on IRC, and I think we reached a general consensus that documentation for individual process plugins should be kept in the API, where it will be most up-to-date and easily linkable from the handbook pages.
The handbook, for its part, will get all of its pages describing individual process plugins ripped out, replaced with a general overview of how the process plugins work, how they fit together in a pipeline, and how to use them in a migration. We'll link to the individual API pages for each process plugin. Therefore, the links are essentially no longer valid and should not be in the doc comments.
Comment #12
xjmStraightforward code documentation improvements can always go into any patch release, alpha, beta, or RC, so please always file them against the production branch (currently 8.3.x). Thanks!
Comment #14
jofitz CreditAttribution: jofitz at ComputerMinds commentedTest-bot error, returning to RTBC.
Comment #15
alexpottCommitted and pushed 24a4d4b to 8.4.x and 789fd08 to 8.3.x. Thanks!
Fixed on commit.