Skip to content

[Notifier] Add Documentation for Events #15597

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
Dec 4, 2022

Conversation

ismail1432
Copy link
Contributor

@ismail1432 ismail1432 commented Aug 6, 2021

I would like to add documentation for the events available in the Notifier, see #15589

I don't know if I have the good approach (create a specific page like for console events)

@carsonbot carsonbot changed the title WIP [Notifier] Event Documentation [Notifier] WIP Event Documentation Aug 6, 2021
@ismail1432 ismail1432 changed the title [Notifier] WIP Event Documentation [Notifier] Add Documentation for Events Aug 6, 2021
@ismail1432 ismail1432 force-pushed the add-notifier-events branch from 917dff9 to 449fe6f Compare August 6, 2021 21:47
@94noni
Copy link
Contributor

94noni commented Dec 28, 2021

I would rathee document it like workflow component events (sub part of doc and not new page)
Nice addition :)

@welcoMattic
Copy link
Member

I guess we need to link your new page here https://symfony.com/doc/current/notifier.html#learn-more

@ismail1432 ismail1432 changed the base branch from 5.4 to 6.1 July 13, 2022 13:58
@ismail1432 ismail1432 changed the base branch from 6.1 to 5.4 July 13, 2022 14:01
@ismail1432
Copy link
Contributor Author

I guess we need to link your new page here https://symfony.com/doc/current/notifier.html#learn-more

Thanks @welcoMattic, from what I understand the instruction notifier/* in file means all pages in the notifier folder will be automatically added so nothing to do specifically.

Learn more
----------

.. toctree::
    :maxdepth: 1
    :glob:

    notifier/*

@welcoMattic
Copy link
Member

@javiereguiluz can you review this one please? I guess it's ok, but I'm not RST master 😄

$message = $event->getOriginalMessage();

// log something
$this->logger(sprintf("The message has been successfully sent and have id: %s, $message->getMessageId()"));
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
$this->logger(sprintf("The message has been successfully sent and have id: %s, $message->getMessageId()"));
$this->logger(sprintf('The message has been successfully sent and have id: %s, $message->getMessageId()'));

@ismail1432 ismail1432 force-pushed the add-notifier-events branch 2 times, most recently from addb23b to 45ea4ac Compare October 29, 2022 14:16
@ismail1432
Copy link
Contributor Author

Hello @OskarStark

Thanks for the review and sorry for the delay I missed the notifications.

@ismail1432
Copy link
Contributor Author

friendly ping 👋

@OskarStark
Copy link
Contributor

It took time, but here we go, this is in now. Thank you very much Smaine.

@OskarStark OskarStark merged commit cdab03a into symfony:5.4 Dec 4, 2022
@OskarStark
Copy link
Contributor

I added a versionadded directive after merging

@ismail1432
Copy link
Contributor Author

No worries @OskarStark and big Thanks for following 👍

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.

5 participants