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

Clarify usage of handler channel configuration #6656

Closed
wants to merge 2 commits into from

Conversation

shkkmo
Copy link
Contributor

@shkkmo shkkmo commented Jun 16, 2016

See: https://github.com/symfony/monolog-bundle/blob/master/DependencyInjection/MonologExtension.php#L88

I believe this applies to all versions of Symfony, so should be merged into the branches of documentation for all of them.

See: https://github.com/symfony/monolog-bundle/blob/master/DependencyInjection/MonologExtension.php#L88

I believe this applies to all versions of Symfony, so should be merged into the branches of documentation for all of them.
@xabbuh
Copy link
Member

xabbuh commented Jun 20, 2016

Thank you for this suggestion @shkkmo. I think you are right with what you suggest. I just think we should maybe not embed it into this paragraph, but add it to its own caution block or the like to make it more outstanding and easier to spot. What do you think?

@shkkmo
Copy link
Contributor Author

shkkmo commented Jun 20, 2016

Sure, didn't know where to added it, but it is definitely a gotcha that i
couldn't figure out till u dug into the source code. How do i add a caution
block?
On Jun 20, 2016 7:28 AM, "Christian Flothmann" notifications@github.com
wrote:

Thank you for this suggestion @shkkmo https://github.com/shkkmo. I
think you are right with what you suggest. I just think we should maybe not
embed it into this paragraph, but add it to its own caution block or the
like to make it more outstanding and easier to spot. What do you think?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#6656 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/ABLK8TBtzO16c6SEvmfnf2WW7DxuOauPks5qNnlUgaJpZM4I36GU
.

@xabbuh
Copy link
Member

xabbuh commented Jun 20, 2016

It will look like this:

.. caution::

    A handler that should log only messages for certain channels must be
    a top-level handler. Handlers nested in filters, groups or other handlers
    will receive every messages regardless of the channel.

I think the best place would be just below the configuration block.

@shkkmo
Copy link
Contributor Author

shkkmo commented Jun 20, 2016

@xabbuh Is this better?

@javiereguiluz
Copy link
Member

👍

Status: reviewed

@shkkmo thanks for contributing this improvement. There are some very minor syntax issues in your pull request, but contributors can easily fix them when merging your work. Thanks!

wouterj added a commit that referenced this pull request Jul 9, 2016
This PR was submitted for the 2.3 branch but it was merged into the 2.7 branch instead (closes #6656).

Discussion
----------

Clarify usage of handler channel configuration

See: https://github.com/symfony/monolog-bundle/blob/master/DependencyInjection/MonologExtension.php#L88

I believe this applies to all versions of Symfony, so should be merged into the branches of documentation for all of them.

Commits
-------

9b4d123 Clarify usage of handler channel configuration
wouterj added a commit that referenced this pull request Jul 9, 2016
@wouterj
Copy link
Member

wouterj commented Jul 9, 2016

Thanks @shkkmo!

I've merged your PR into the 2.7 version of the docs (we dropped 2.3 support in the meantime). Afterwards, I've fixed the syntax to comply with our doc standards in 65a20c8.

@wouterj wouterj closed this Jul 9, 2016
weaverryan added a commit that referenced this pull request Jul 10, 2016
* 2.7: (31 commits)
  Removing old :term: stuff
  Replacing missing link
  Fixing typo
  Final changes
  [WIP] More changes
  [WIP] More changes
  [WIP] Removing multiple formats - it makes no sense here
  [WIP] More changes
  [WIP] Reading through the changes
  changes according to comments after PR + some other typos
  typo fix in hyperlink
  typo fix in hyperlink
  colon  corrections
  made some new changes, corrected mistakes, undo some foolish deletions
  [] changes in the first four ch of the book
  [#6656] Fix syntax to comply with docs standards
  Clarify usage of handler channel configuration
  replace occurrences of <?php echo with <?=
  Improve comment
  If context is defined, it is used instead of the firewall
  ...
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.

None yet

5 participants