Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
Problem/Motivation
FieldableEntity provides a base class for migration source plugins from Drupal.
It has two methods, getFields() and getFieldValues(). These explain what they do, but they could do to also explain how they should be used.
See https://api.drupal.org/api/drupal/core%21modules%21node%21src%21Plugin%2... for an example.
Steps to reproduce
Proposed resolution
Remaining tasks
User interface changes
API changes
Data model changes
Release notes snippet
Comment | File | Size | Author |
---|---|---|---|
#12 | 3203009-12.patch | 1.36 KB | quietone |
#12 | interdiff-5-12.txt | 1.45 KB | quietone |
#5 | 3203009-5.patch | 1.34 KB | quietone |
Issue fork drupal-3203009
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:
Comments
Comment #3
quietone CreditAttribution: quietone as a volunteer commented@joachim, I'm not sure what you are looking for here. Can you provide an example of the documentation you'd like to see?
Comment #4
joachim CreditAttribution: joachim as a volunteer commentedLooking at the code, I think I meant that both of them should say they are helpers for prepareRow(), and getFieldValues() should also say that its return value is intended for setSourceProperty().
(I need to try to give more detail in documentation issues, as clearly what seems obvious to me at the time isn't obvious later even to me! sorry!)
Comment #5
quietone CreditAttribution: quietone as a volunteer commentedThanks! How is this?
Having come across quite a few of your documentation issues I agree with your self assessment. Having a sentence or even a phrase to start with would be really helpful. I just assume that you are focused on debugging something and don't want to lose your train of thought.
Comment #6
joachim CreditAttribution: joachim as a volunteer commented> I just assume that you are focused on debugging something and don't want to lose your train of thought.
Yes, it's pretty much that!
Your text looks perfect! Thanks!
Comment #7
catchNit: I think we can drop the 'This is' from both comments. But otherwise looks good.
Comment #10
Gauravvvv CreditAttribution: Gauravvvv at OpenSense Labs for Drupal India Association commentedComment #11
Gauravvvv CreditAttribution: Gauravvvv at OpenSense Labs for Drupal India Association commentedMR updated as per #7.
Comment #12
quietone CreditAttribution: quietone as a volunteer commented@Gauravmahlawat, remember to follow Drupal coding standards. The changes made in the MR should wrap at 80 columns.
#7. Without the 'This is', then sentence needs to change a bit so that there is a comma after 'Typically'. I made a new patch based of the patch in #5 (I am not keen on working with MRs).
Comment #13
joachim CreditAttribution: joachim at Factorial GmbH, TrainingCloud commentedI don't really see how having to use the name of the method in the docblock for that method is better than saying 'This is'; it's definitely not as succinct... But I think it's fine like this.
Comment #14
catchHmm I just meant 'Typically used in...' as in literally drop the two words.
Comment #15
quietone CreditAttribution: quietone as a volunteer commentedSorry, forgot to add that it wasn't until I read the suggested change that it didn't seem right. So searched, and found that https://dictionary.cambridge.org/example/english/typically, uses the comma after typically when it begins a sentence.
Comment #16
quietone CreditAttribution: quietone as a volunteer commentedSince this is RTBC, let's run the tests.
Comment #17
alexpottCommitted and pushed 76f6b690e1 to 9.3.x and a1ed6ed5d0 to 9.2.x. Thanks!