Problem/Motivation

The code comments in the README.md file for the settings.php configuration snippet are incorrect and swapped. This can be confusing for developers trying to use the module.

The current README.md shows the following under SETTINGS.PHP CODE SNIPPETs:

// Force enable/disable displaying a Drupal status message when the mail is
// being rerouted.
$config['reroute_email.settings']['description'] = TRUE;

// Force enable/disable inserting a message into the email body when the mail
// is being rerouted.
$config['reroute_email.settings']['message'] = TRUE;

The comments are swapped.

Steps to reproduce

Test the 2 code lines separately in settings.php and see what happenes.

Proposed resolution

The correct code should be:

// Force enable/disable displaying a Drupal status message when the mail is
// being rerouted.
$config['reroute_email.settings']['message'] = TRUE;

// Force enable/disable inserting a rerouting description into the email body when the mail
// is being rerouted.
$config['reroute_email.settings']['description'] = TRUE;

Remaining tasks

Comments

marco.b created an issue. See original summary.

liam morland’s picture

Status: Active » Closed (duplicate)
Related issues: +#3523264: Override instructions in README.md seem incorrect

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.