8000 Reword kernel.event_listener description · Issue #4680 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Reword kernel.event_listener description #4680

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.

Sign up for GitHub

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

Jump to bottom
Closed
wouterj opened this issue Dec 23, 2014 · 3 comments
Closed

Reword kernel.event_listener description #4680

wouterj opened this issue Dec 23, 2014 · 3 comments
Labels
actionable Clear and specific issues ready for anyone to take them. DependencyInjection EventDispatcher good first issue Ideal for your first contribution! (some Symfony experience may be required) hasPR A Pull Request has already been submitted for this issue.

Comments

@wouterj
Copy link
Member
wouterj commented Dec 23, 2014

In the DIC tags reference, we should reword the description of the kernel.event_listener tag. Currently, it can be understood wrongly as something that's only meant for core things.

Thanks to our IRC friends for reporting this issue!

ChairmanOfBoard: What I stumped at, was that it seemed like kernel.event_listener was just for core events, and that somehow I felt maybe one should create their own event dispatcher outside the main one
Lumbendil: no
Lumbendil: what made you think such a thing? :)
ChairmanOfBoard: This doc
ChairmanOfBoard: http://symfony.com/doc/current/reference/dic_tags.html
ChairmanOfBoard: For example, if you have a service that you would like to register as a listener to one of Symfony's core events, you can flag it with the kernel.event_listener tag.
ChairmanOfBoard: I don't think I thought enough about that line, and took it the wrong way
ChairmanOfBoard: Also the name "kernel.event_listener" makes it sound like its just for kernel events
@wouterj wouterj added good first issue Ideal for your first contribution! (some Symfony experience may be required) actionable Clear and specific issues ready for anyone to take them. DependencyInjection EventDispatcher labels Dec 23, 2014
@bicpi
Copy link
Contributor
bicpi commented Mar 28, 2015

@wouterj I don't quite get what is confusing here. Is it the description in the overview table at the beginning or the detailed description?

@wouterj
Copy link
Member Author
wouterj commented May 3, 2015

It's not the documentation that is confusing, it's the name of the tag. As we can't rename the tag simply, we should make it clear to explicitely tell them that this tag is for your own listeners/subscribers.

@javiereguiluz javiereguiluz mentioned this issue Jun 26, 2015
Merged
@javiereguiluz
Copy link
Member

I'm trying to reword this content in #5445 but I don't know if the new explanation is better than the existing one.

@wouterj wouterj added the hasPR A Pull Request has already been submitted for this issue. label Jun 27, 2015
weaverryan added a commit that referenced this issue Dec 23, 2015
@weaverryan
minor #5445 Reworded the explanation about the kernel.event_listener …
ed5a02a 
…tag (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Reworded the explanation about the kernel.event_listener tag

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | #4680

Commits
-------

edd3875 Restored some content deleted by mistake
58d6346 Minor rewording
db7b78f Reworded the explanation about the kernel.event_listener tag
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actionable Clear and specific issues ready for anyone to take them. DependencyInjection EventDispatcher good first issue Ideal for your first contribution! (some Symfony experience may be required) hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@javiereguiluz @weaverryan @bicpi @wouterj
0