Problem/Motivation

The example for module hook_help in
https://drupal.org/node/632280
includes a section on permissions.

But the example from the standard, had its permission help removed.

Proposed resolution

a) update the example in the hook help standard to use an example that actually should include info about permissions
b) decide permissions do not need to be documented in module hook help
c) add permission info (back) to modules that have permissions, like content translation, config translation, ... a bunch of others.

Remaining tasks

  • discuss

User interface changes

No

API changes

No

Comments

yesct’s picture

yesct commented
Issue summary: View changes

(actually link to the standard)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I think the example on the standards page is OK -- the help text example is from D7 I believe, and I believe it does still have the permissions in it.

I also think it's a decent example, and that most of the hook_help for d7 and d8 does mention specific permissions. I'm not sure we need a rigid standard saying "you must always talk about permissions, but I think it's good that the example mentions them.

So ... not sure if we need to do anything about the standard here? Maybe we need to revisit the D8 content translation module help and add something about permissions to it?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Closed (works as designed)

At this point we've been using the standards page successfully in 8 for a while, I'm just going to close the issue.