API page: https://api.drupal.org/api/drupal/modules!simpletest!drupal_web_test_cas...

This says: 'Internal helper function'.

However, it's useful to be able to create roles in tests. So considering this as internal is not ideal. Moreover, Drupal core is already violating this: the list of calls to this method shows that 2 test cases in user module are making use of this.

Therefore, either the documentation text is wrong, or the use of this method is wrong. I would say the former.

CommentFileSizeAuthor
#12 interdiff-1-12.txt418 bytescs_shadow
#12 drupal-drupal_create_role_documentation-2234611-12.patch526 bytescs_shadow
#4 drupal8.create-role-documentation-223461-04.patch633 bytesvisabhishek
#1 drupal-drupal_create_role_documentation-2234611-1.patch525 bytescs_shadow
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

cs_shadow’s picture

cs_shadow CreditAttribution: cs_shadow commented
FileSize
drupal-drupal_create_role_documentation-2234611-1.patch525 bytes

Removed the phrase 'Internal helper function' from the documentation.

joachim’s picture

joachim CreditAttribution: joachim commented
Status: Active » Needs review

Let's set this to needs review to get the testbot's approval.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Version: 7.x-dev » 8.x-dev
Status: Needs review » Needs work

Needs to be fixed in Drupal 8 first, then backported.

And please also fix the first line to start with "Creates" not "Create".

visabhishek’s picture

visabhishek CreditAttribution: visabhishek commented
Status: Needs work » Needs review
FileSize
drupal8.create-role-documentation-223461-04.patch633 bytes

Patch created for D8 as per #3.

joachim’s picture

joachim CreditAttribution: joachim commented
Status: Needs review » Reviewed & tested by the community
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Version: 8.x-dev » 7.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)
Issue tags: +Needs backport to D7

Thanks! Committed to 8.x. Need new patch now for 7.x.

  • Commit ebdb310 on 8.x by jhodgdon: 
    Issue #2234611 by visabhishek, cs_shadow, joachim: Fix up docs for...
cs_shadow’s picture

cs_shadow CreditAttribution: cs_shadow commented

1: drupal-drupal_create_role_documentation-2234611-1.patch queued for re-testing.

cs_shadow’s picture

cs_shadow CreditAttribution: cs_shadow commented
Status: Patch (to be ported) » Needs review

Patch in #1 was initially for 7.x only so retesting to check if it still applies cleanly.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

See #3. Needs new patch for 7.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work
cs_shadow’s picture

cs_shadow CreditAttribution: cs_shadow commented
Status: Needs work » Needs review
FileSize
drupal-drupal_create_role_documentation-2234611-12.patch526 bytes
interdiff-1-12.txt418 bytes

Attaching the patch and interdiff.

joachim’s picture

joachim CreditAttribution: joachim commented
Status: Needs review » Reviewed & tested by the community
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Reviewed & tested by the community » Fixed

Thanks! Committed to 7.x.

  • Commit 79d304a on 7.x by jhodgdon: 
    Issue #2234611 by visabhishek, cs_shadow, joachim: Fix up docs for...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.