Skip to content
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

Document the new debug:event-dispatcher #4230

Closed
weaverryan opened this issue Sep 15, 2014 · 6 comments
Closed

Document the new debug:event-dispatcher #4230

weaverryan opened this issue Sep 15, 2014 · 6 comments
Milestone

Comments

@weaverryan
Copy link
Member

See symfony/symfony#10388

I think this may be useful to mention somewhere where we're talking about events and listeners.

@matthieuauger
Copy link
Contributor

Wow, too fast @weaverryan ! I'll take care of the documentation of the feature.

For now if you're OK with the PR, maybe we could add the documentation about the new debug namespace (#4210)

@weaverryan
Copy link
Member Author

@matthieuauger I saw the code PR got merged and didn't want to forget about this! :)

I just added a few comments to your PR, then it's definitely ready to merge. If there is an obvious spot, you could - if you want - add the debug:event-dispatcher notes on that PR.

Thanks!

@matthieuauger
Copy link
Contributor

If you don't mind, I'd rather create a new PR for this documentation.

Thanks for your feedback

@wouterj wouterj added this to the 2.6 milestone Sep 16, 2014
@matthieuauger
Copy link
Contributor

Hi,

I can't find any good place to add the documentation of this feature.

The DIC and router have specific sections in the book which explain their integration in Symfony and their related debugging commands. But the Event Dispatcher is only documented as a standalone component and I don't think we should add something specific to Symfony there.

What do you think ? Any ideas about where to add this ?

Thanks

@wouterj
Copy link
Member

wouterj commented Sep 23, 2014

@matthieuauger don't we also talk about events in the cookbook?

@weaverryan
Copy link
Member Author

Yep, @matthieuauger the best place I can see is here: http://symfony.com/doc/current/cookbook/service_container/event_listener.html. I think we could mention it right away, since we currently say:

Those events are thrown by the HttpKernel component and can be viewed in the KernelEvents class.

Really, we could say that Symfony - and other bundles - dispatch events. To see a list, run this command, etc etc.

weaverryan added a commit that referenced this issue Nov 3, 2014
…ieuauger)

This PR was merged into the master branch.

Discussion
----------

Documentation for debug:event-dispatcher command

See #4230

As my english is far from perfect, I tried to make it short. Any feedback/suggestions welcome

Commits
-------

a4fed11 Documentation for debug:event-dispatcher command
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants