Skip to content

Revamped the reference/events.rst article #8649

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 2 commits into from
Nov 16, 2017

Conversation

javiereguiluz
Copy link
Member

While upgrading some contents yesterday, I realized that this article is not as good as it should be, considering how important it is.

The changes I propose:

  • For each event, clearly explain when it's dispatched and what you can do with it (without duplicating the full explanations found in components/http_kernel.rst)
  • Remove the tables showing the list of listeners/subscribers for each event. This is too hard to maintain and it depends on the components installed in your application. Let's mention the debug:event-dispatcher command instead.

The last change is important because the information provided currently is wrong. See for example the Symfony Demo app:

event-mismatch

@weaverryan weaverryan merged commit 9703922 into symfony:2.7 Nov 16, 2017
weaverryan added a commit that referenced this pull request Nov 16, 2017
This PR was squashed before being merged into the 2.7 branch (closes #8649).

Discussion
----------

Revamped the reference/events.rst article

While upgrading some contents yesterday, I realized that this article is not as good as it should be, considering how important it is.

The changes I propose:

* For each event, clearly explain when it's dispatched and what you can do with it (without duplicating the full explanations found in `components/http_kernel.rst`)
* Remove the tables showing the list of listeners/subscribers for each event. This is too hard to maintain and it depends on the components installed in your application. Let's mention the `debug:event-dispatcher` command instead.

The last change is important because the information provided currently is wrong. See for example the Symfony Demo app:

![event-mismatch](https://user-images.githubusercontent.com/73419/32771545-48521732-c923-11e7-9c20-af7b40c37223.png)

Commits
-------

9703922 Fixed RST syntax issue
dff597e Revamped the reference/events.rst article
weaverryan added a commit that referenced this pull request Nov 16, 2017
@weaverryan
Copy link
Member

Great job! I like the update and I really like the removal of unnecessary/duplicated information.

weaverryan added a commit that referenced this pull request Nov 21, 2017
* 2.7:
  Some fixes for testing/* articles in 2.7 docs
  Fixed some issues in PHPUnit XML config examples
  Removed a wrong note about controllers as services
  Removed lots of redundant contents
  [#8650] Minor rewording
  [#8649] Small reword
  Improved the link to the Symfony events reference
  Minor fixes for upload_file.rst
  Fixed a typo
  Added getSubscribedEvents() to UserLocaleSubscriber
  Reworded the explanation about service tags
  Reworded the intro of reference/dic_tags.rst
  Fixed RST syntax issue
  Revamped the reference/events.rst article
  Change some docs to be gender-neutral
weaverryan added a commit that referenced this pull request Nov 21, 2017
* 2.8:
  Some fixes for testing/* articles in 2.7 docs
  Fixed some issues in PHPUnit XML config examples
  Removed a wrong note about controllers as services
  Removed lots of redundant contents
  [#8650] Minor rewording
  [#8649] Small reword
  Improved the link to the Symfony events reference
  Minor fixes for upload_file.rst
  Fixed a typo
  Added getSubscribedEvents() to UserLocaleSubscriber
  Reworded the explanation about service tags
  Reworded the intro of reference/dic_tags.rst
  Fixed RST syntax issue
  Revamped the reference/events.rst article
  Change some docs to be gender-neutral
weaverryan added a commit that referenced this pull request Nov 21, 2017
* 3.3: (34 commits)
  Removed a deprecated feature in a testing article
  Some fixes for testing/* articles in 2.7 docs
  A few tiny encore tweaks
  Fixed some issues in PHPUnit XML config examples
  Minor typos in session articles
  Removed a wrong note about controllers as services
  Removed lots of redundant contents
  fix typo
  Update micro_kernel_trait.rst
  Update micro_kernel_trait.rst
  [#8650] Minor rewording
  [#8649] Small reword
  Improved the link to the Symfony events reference
  Minor fixes for upload_file.rst
  added commas for php code section
  [Workflow] minor tweaks
  Fixed a typo
  Fix minor typo
  Added getSubscribedEvents() to UserLocaleSubscriber
  [Config] Add missing paranthesis of `arrayPrototype` method
  ...
weaverryan added a commit that referenced this pull request Nov 21, 2017
* 3.4: (34 commits)
  Removed a deprecated feature in a testing article
  Some fixes for testing/* articles in 2.7 docs
  A few tiny encore tweaks
  Fixed some issues in PHPUnit XML config examples
  Minor typos in session articles
  Removed a wrong note about controllers as services
  Removed lots of redundant contents
  fix typo
  Update micro_kernel_trait.rst
  Update micro_kernel_trait.rst
  [#8650] Minor rewording
  [#8649] Small reword
  Improved the link to the Symfony events reference
  Minor fixes for upload_file.rst
  added commas for php code section
  [Workflow] minor tweaks
  Fixed a typo
  Fix minor typo
  Added getSubscribedEvents() to UserLocaleSubscriber
  [Config] Add missing paranthesis of `arrayPrototype` method
  ...
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.

4 participants