The documentation in TableMappingInterface has grammatical errors and structural issues that make it confusing.
Current problematic text:
The return list is contains the entity field names, not database field
* (i.e. column) namesProblems:
- Grammar error: "is contains" should be "contains"
- The return description is mixed into the method description instead of being in the @return tag
- Missing article "the" before "database field"
Proposed solution:
Move the return description to the @return docblock tag:
@return A list of field names for the given table. Note these are entity field names, not database field (i.e. column) names. To get the mapping of specific entity field to database columns use ::getColumnNames().
This separates the return value documentation from the method description, fixes the grammar, and provides helpful cross-reference to ::getColumnNames().
Credit: Issue identified by chx
Issue fork drupal-3570447
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 #5
longwaveThanks for working on this, and welcome to Drupal!
Made a minor fix to the formatting, but otherwise LGTM.
Comment #9
catchCommitted/pushed to main and 11.x, thanks!