Opened 6 years ago
Last modified 6 years ago
#30316 closed Cleanup/optimization
Link to default logging dictConfig in documentation — at Version 5
| Reported by: | Andrew Badr | Owned by: | Ahisahar Pretel |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description (last modified by )
When people want to customize Django's logging, my guess is that they'll most often want to start by changing something about the default logging setup. Toward this end, it would be helpful if the Django docs included a dictConfig for the default logging setup. Instead, the docs *describe* the default settings (https://docs.djangoproject.com/en/2.1/topics/logging/#default-logging-configuration), and give dictConfigs for several other possible configurations for logging (https://docs.djangoproject.com/en/2.1/topics/logging/#configuring-logging).
Change History (5)
comment:1 by , 6 years ago
| Easy pickings: | set |
|---|---|
| Needs documentation: | set |
comment:2 by , 6 years ago
| Component: | Uncategorized → Documentation |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | Uncategorized → Cleanup/optimization |
| Version: | 2.2 → master |
comment:3 by , 6 years ago
| Summary: | Include default logging dictConfig in documentation → Link to default logging dictConfig in documentation |
|---|
comment:4 by , 6 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
Hi, this is my first easy picking fix. I will assign the issue to myself and submit the PR this evening if that is ok.
comment:5 by , 6 years ago
| Description: | modified (diff) |
|---|
Note:
See TracTickets
for help on using tickets.
I don't think copying the full config would be great. There are already lots of examples in the doc for people to use.
However... getting people to look at the source is always worth it, so a single line link to
django/utils/log.py— "For Reference the default logging config is defined in..." (See a68c029e224cebe540da7447dbbd27993b4aa793 forsourceextlink examples.) — would be good.