Add examples describing error handling in ActiveSupport::Notification… #34707
Conversation
| # (<tt>ActiveSupport::Notifications::Event</tt>) to the sql method. | ||
| # | ||
| # Being an <tt>ActiveSupport::Notifications</tt> consumer, | ||
| # <tt>ActiveRecord::LogSubscriber</tt> exposes simple interface to check if |
There was a problem hiding this comment.
ActiveRecord::LogSubscriber exposes a simple interface
There was a problem hiding this comment.
Thx @gmcgibbon, this is now fixed -- it's always good to have some native speaker's feedback in PRs like this one. Anyway, this also made me realize that we should refer to ActiveSupport::LogSubscriber rather than ActiveRecord::LogSubscriber
| # | ||
| # Being an <tt>ActiveSupport::Notifications</tt> consumer, | ||
| # <tt>ActiveSupport::LogSubscriber</tt> exposes a simple interface to check if | ||
| # instrumented code raised an exception. It is common to log a different |
There was a problem hiding this comment.
I would also change this to "instrumented code raises an exception"
…s and ActiveSupport::LogSubscriber documentation files
xlts
force-pushed
the
update-notifications-docs
branch
from
edeb477
to
2701a18
Compare
|
@gmcgibbon I applied your suggestions. Let me know if something else needs updating before this one can be merged |
|
When testing the code sample, I don't see the subscriber actually output anything. This is because we're not calling any logging methods and just returning the strings, which is wrong. This is also present in the previous example, so I'd rather be consistently wrong for now. I'll fix this in a followup PR. |
…s and ActiveSupport::LogSubscriber documentation files
Summary
This PR adds some missing code samples describing error handling in
ActiveSupport::NotificationsandActiveSupport::LogSubscriberdocumentation files. It also includes some minor formatting updates toActiveSupport::LogSubscriberdocs.