Improve documentation for "activate_announcer_on_command_failure"

[maxmeyer]

Summary

The documentation "activate_announcer_on_command_failure" is not helpful for users as it misses information about what arguments this option takes, e.g.

  config.activate_announcer_on_command_failure = [:stderr, :stdout, :command]

Expected Behavior

Documentation contains all required information.

Current Behavior

Documentation lacks this information

Possible Solution

Improve documentation and add announcers found here to documentation https://github.com/cucumber/aruba/blob/f134e1f941081524369dbd8d9b7d49d31423108a/lib/aruba/cucumber/hooks.rb#L82.

Steps to Reproduce (for bugs)

1. Visit https://app.cucumber.pro/projects/aruba/documents/branch/master/features/02_configure_aruba/activate_announcer_on_command_failure.feature and try to configure aruba

Context & Motivation

Please be aware of this issue: https://github.com/cucumber/aruba/issues/416.

Your Environment

• Version used: latest
• Operating System and version: Linux
• Link to your project: internal

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week if no further activity occurs.

[stale[bot]]

This issue has been automatically closed because of inactivity. You can support the Cucumber core team on opencollective.

[xtrasimplicity]

Reopening as this can be ultra useful.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week if no further activity occurs.

[stale[bot]]

This issue has been automatically closed because of inactivity. You can support the Cucumber core team on opencollective.