Skip to content

[Notifier] add notification assertion in notifier doc #17719

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

Merged
merged 1 commit into from
Jan 12, 2023

Conversation

MrYamous
Copy link
Contributor

While reading testing documentation I came across some assertions for notifications. I think it can be useful to talk about this directly in Notifier documentation too, WDYT ?

notifier.rst Outdated
which provide useful methods for testing your Notifier implementation.
You can benefit from this class by using it directly or extending :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\KernelTestCase`.

See :ref:`testing documentation <notifier-assertions>` for list of availables assertions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See :ref:`testing documentation <notifier-assertions>` for list of availables assertions.
See :ref:`testing documentation <notifier-assertions>` for the list of available assertions.

notifier.rst Outdated
Testing Notifier
----------------

With FrameworkBundle Symfony provide a :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\NotificationAssertionsTrait`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
With FrameworkBundle Symfony provide a :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\NotificationAssertionsTrait`
Symfony provides a :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\NotificationAssertionsTrait`

notifier.rst Outdated

With FrameworkBundle Symfony provide a :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\NotificationAssertionsTrait`
which provide useful methods for testing your Notifier implementation.
You can benefit from this class by using it directly or extending :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\KernelTestCase`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can benefit from this class by using it directly or extending :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\KernelTestCase`.
You can benefit from this class by using it directly or extending the :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\KernelTestCase`.

notifier.rst Outdated

.. versionadded:: 6.2

The Notifier assertions were introduced in Symfony 6.2.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Notifier assertions were introduced in Symfony 6.2.
The :class:`Symfony\\Bundle\\FrameworkBundle\\Test\\NotificationAssertionsTrait` was introduced in Symfony 6.2.

@MrYamous
Copy link
Contributor Author

Thanks Oskar Stark for review 😃

@OskarStark OskarStark force-pushed the notifier/link-testing-notifier branch from e670373 to 8583932 Compare January 12, 2023 12:32
@OskarStark
Copy link
Contributor

Thank you @MrYamous.

@OskarStark OskarStark merged commit 6128fe2 into symfony:6.2 Jan 12, 2023
javiereguiluz added a commit that referenced this pull request Jan 13, 2023
This PR was merged into the 5.4 branch.

Discussion
----------

[Mailer] update mailer testing documentation

Comparable as #17719 to make MailerAssertionsTrait more visible
And minor update for example

Commits
-------

96ff886 update mailer testing documentation
@MrYamous MrYamous deleted the notifier/link-testing-notifier branch March 8, 2023 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants