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.
Problem/Motivation
The module description should only be one sentence that easy to understand for new users. It should also be so short that users don't need to scroll sideways.
See https://www.drupal.org/docs/develop/documenting-your-project/help-text-s...
Proposed resolution
Reword the description to something like "provides an interface to create workflows with transitions between different publication states."
Remaining tasks
None
User interface changes
This is a UI text change.
API changes
None.
Data model changes
None.
Comment | File | Size | Author |
---|---|---|---|
#11 | 2999423-workflows-module-description-11.patch | 660 bytes | ifrik |
#7 | Screen Shot 2018-09-22 at 17.07.01.png | 35.03 KB | John Cook |
#7 | Screen Shot 2018-09-22 at 17.05.47.png | 40.88 KB | John Cook |
#6 | 2999423-workflows-module-description-6.patch | 631 bytes | ifrik |
#2 | 2999423-workflows-module-description-2.patch | 632 bytes | ifrik |
Comments
Comment #2
ifrikComment #3
ifrikComment #4
wengerkThanks for your proposal. Seems fine to me.
Comment #5
alexpottWhilst YAML supports a multiline formats I think this would be the first in core. I think if we want to make this change we should be consistent and introduce a standard and enforce it via PHPCS. For example, seven.info.yml has a very long description too.
+1 to rewording the description though. Also if we do make this multi-line we need to check that the potx extractor still manages to read these lines.
Comment #6
ifrikIt hadn't even been my intention to introduce this a new pattern :-)
It's all in one line now.
Comment #7
John Cook CreditAttribution: John Cook at Creode commentedI've checked the patch in comment 6.
Before:
After:
The description is now one sentence and is shorter than previously.
Setting to RTBC.
Comment #8
Gábor HojtsyThe module is not really limited for publication states. It can set up a workflow for user status (Newbie, Intermediate, Pro) or any other states and transitions. Publication states is just one possible use which is why the two modules are separate.
Comment #10
ifrikWorking on it during DevDaysTransylvania together with #2861849: Edit hook_help text for Workflows module
Comment #11
ifrikChanged the wording so that it's clear that this can apply to different types of states.
Comment #12
pguillard CreditAttribution: pguillard commentedIt seems good to me, not too long, and not too specific.
Comment #13
pguillard CreditAttribution: pguillard commentedLet's go for RTBC !
Comment #14
catchCommitted ca0daca and pushed to 8.8.x. Thanks!