Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve config documentation for disallowed_notification_payload_keys and notification_payload_transform #969

Open
kaylareopelle opened this issue May 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open

Comments

@kaylareopelle
Copy link
Contributor

The new Action Mailer instrumentation (#887) and existing instrumentation for Action View include configuration options named disallowed_notification_payload_keys and notification_payload_transform. They may also be present in other Rails-related instrumentation.

These options don't have a lot of documentation.

We should consider:

  • Updating the README to describe these options
  • Updating the class comments in the file that contains the options method call to include descriptions

Try to apply the documentation updates to all instrumentation with these configuration options.

@kaylareopelle kaylareopelle added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 15, 2024
Copy link
Contributor

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label Jun 15, 2024
@arielvalentin arielvalentin added the keep Ensures stale-bot keeps this issue/PR open label Jun 16, 2024
@kaylareopelle kaylareopelle removed the stale Marks an issue/PR stale label Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open
Projects
None yet
Development

No branches or pull requests

2 participants