Skip to content

Commit ca87788

Browse files
adriendupuismnocon
andauthored
Apply suggestions from code review
Co-authored-by: Marek Nocoń <mnocon@users.noreply.github.com>
1 parent 3857901 commit ca87788

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/administration/back_office/notifications.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ month_change: false
55

66
# Notifications
77

8-
You can send two types of notifications to the users.
8+
You can send two types of notifications to the users:
99

1010
- [Notification bar](#notification-bars) is displayed in specific situations as a message bar appearing at the bottom of the page.
1111
It appears to whoever is doing a specific operation in the back office.
@@ -77,11 +77,11 @@ The values shown above are the defaults.
7777

7878
To send notification bars, you can also subscribe to a notification with the `browser` channel.
7979

80-
For more information, see [Notifications to channels](notification_channels.md).
80+
For more information, see [Notifications channels](notification_channels.md).
8181

8282
## User notifications
8383

84-
You can send notifications to the user which are displayed in the user menu.
84+
You can send notifications to users which are displayed in the user menu.
8585

8686
![Screenshot of the user menu with an highlight on the bell icon](notification3.png "Profile notification bell menu")
8787

@@ -94,7 +94,7 @@ like in the example below:
9494
[[= include_file('code_samples/back_office/notifications/src/EventListener/ContentPublishEventListener.php') =]]
9595
```
9696

97-
A new type of user notification is created: `ContentPublished`
97+
A new type of user notification is created: `ContentPublished`.
9898

9999
### Display a custom user notification
100100

@@ -134,4 +134,4 @@ The example below presents a modified renderer that uses Twig to render a list v
134134

135135
To send user notifications, you can also subscribe to a notification with the `ibexa` channel.
136136

137-
For more information, see [Notifications to channels](notification_channels.md).
137+
For more information, see [Notifications channels](notification_channels.md).

docs/api/notification_channels.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ This page contains several examples of subscriptions configuration.
7272

7373
Subscriptions defined for a scope may not merge with subscriptions from other scopes or from other files.
7474
For example, `default` scope might not be merged within a siteaccess group scope.
75-
To ensure you don't unsubscribe against your will,
75+
To ensure you don't unsubscribe channels by mistake,
7676
always use the following command to check subscriptions for a siteaccess before and after any changes:
7777

7878
```bash
@@ -108,11 +108,11 @@ You can define a new notification type and assign a new set of channels to it, c
108108
It must extend the `Symfony\Component\Notifier\Notification\Notification` class
109109
and can optionally implement interfaces required by specific channels.
110110

111-
- Some channels don't accept the notification if it doesn't implement their related notification interface.
112-
Those interfaces come with a method to specifically format the notification for the channel.
113-
- Some channels accept every notification and have a default formatting if the notification doesn't implement their related notification interface.
111+
- Some channels don't accept the notification if it doesn't implement their specific notification interface.
112+
These interfaces come with a method to specifically format the notification for the channel.
113+
- Some channels accept every notification and have a default formatting if the notification doesn't implement their specific notification interface.
114114

115-
| Channel | Specific notification interface | Accept any notification |
115+
| Channel | Specific notification interface | Accepts any notification object|
116116
|:----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
117117
| `actito` | `Symfony\Component\Notifier\Notification\EmailNotificationInterface` | **No** |
118118
| `chat` | `Symfony\Component\Notifier\Notification\ChatNotificationInterface` | Yes |
@@ -256,11 +256,11 @@ Subscribe to this new notification type in `config/packages/notifications.yaml`:
256256
php bin/console ibexa:debug:config notifications.subscriptions --siteaccess=site
257257
```
258258

259-
Reaching this controller in the back office (at `/admin/notification-sender`) triggers the notification as a flash message in the bottom-right corner:
259+
Visiting this controller's route in the back office (at `/admin/notification-sender`) triggers the notification as a flash message in the bottom-right corner:
260260

261261
![Notification in back office](notification-browser-admin.png "Controller message displayed as a flash message in the browser")
262262

263-
Reaching the controller in the default SiteAccess on Commerce edition (at `/notification-sender`) also triggers the notification as a flash message in the bottom-right corner:
263+
Visiting the controller's route in the default SiteAccess on Commerce edition (at `/notification-sender`) also triggers the notification as a flash message in the bottom-right corner:
264264

265265
![Notification in storefront](notification-browser-storefront.png "Controller message displayed as a flash message in the browser")
266266

0 commit comments

Comments
 (0)