-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Fully document monolog bundle configuration #2862
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
Comments
I'll fix (1) today. |
@Seldaek to which symfony version does this apply? |
@wouterj MonologBundle is not released in sync with Symfony anymore. MonologBundle 2.4 has been released today with new features compatible with Symfony 2.3+ |
@stof thanks! So, we need to document this in 2.3+? |
yes |
For (1), I don't think we've done this yet, but how about just linking to the PHP docs from the config reference section? I'd like to not duplicate all of these little details. For more complex handlers, we could additionally include an example. |
I don't see anything wrong with this. I guess we use something like this in the documentation of the HTTP status code constants, don't we? |
what about documenting |
I didn't even know about Yes, I think we should just add a link from our reference section to the GitHub source code for the above-linked Configuration class. That would go a long way to helping people find handlers and configuration options that they probably don't know exist. The docs above the Configuration class are really great. |
It's been two years since this issue was opened. I think it's time to close it as "won't fix". Besides, I don't see the point of duplicating the information that is already included in the PHPdoc. And if we really want to put that information in a real documentation, don't you think it should be included in the Monolog doc and not in Symfony doc or Monolog bundle doc? |
Well, it doesn't belong in monolog much IMO, at least not yet, maybe in 2.0 if we have option arrays they could map closer to the symfony config. Anyway what could be a thing is to at least link to the configuration source file from the docs "for more info see there"? |
Agree with @Seldaek - this isn't a "wont fix" it's just a "nobody has done it yet" - it's a simple issue - just add a link from the monolog configuration reference to https://github.com/symfony/MonologBundle/blob/master/DependencyInjection/Configuration.php#L24-155 to help people out. I agree @javiereguiluz that there's no reason to duplicate :) |
Here are a few things that got added today that would be nice to find in the docs I think for discoverability:
That is all, thanks!
The text was updated successfully, but these errors were encountered: