Notification Documentation#320
Merged
TylerPachal merged 1 commit intocommanded:masterfrom Mar 2, 2026
Merged
Conversation
TylerPachal
commented
Mar 2, 2026
| @@ -1,11 +1,11 @@ | |||
| defmodule EventStore.Notifications.Listener do | |||
| @moduledoc false | |||
| @moduledoc """ | |||
Contributor
Author
There was a problem hiding this comment.
Annotation: Added some key tems like GenStage and full module names.
TylerPachal
commented
Mar 2, 2026
Comment on lines
+1
to
+4
| defmodule EventStore.Notifications.NotificationTest do | ||
| use ExUnit.Case, async: true | ||
| doctest EventStore.Notifications.Notification | ||
| end |
Contributor
Author
There was a problem hiding this comment.
Annotation: I didn't see any unit tests for this module so I added the doctest to have something in place.
drteeth
approved these changes
Mar 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
moduledocto some of theEventStore.Notifications.*modules. Some existing documentation was in place, but I added fully qualified module names in the documentation so that its easier to build the bigger picture of how the notifications work. In addition for this being nice for us humans, I think it will be useful for Claude to gather context.In other projects, I have seen Claude perform much better when it can learn from in-module documentation (as opposed to top-level guides).