Document how to silence the deprecation warnings
Open
Nobody has claimed this yet.
Task
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Some users may not want to see the deprecation warnings. Here's a diff that is applied directly to the settings file on how to disable them.
diff --git a/pulpcore/app/settings.py b/pulpcore/app/settings.py
index 422beb796..32278f4a6 100644
--- a/pulpcore/app/settings.py
+++ b/pulpcore/app/settings.py
@@ -229,6 +229,11 @@ LOGGING = {
"level": "WARNING",
"propagate": False,
},
+ "pulpcore.deprecation": {
+ "handlers": ["console"],
+ "level": "ERROR",
+ "propagate": False,
+ }
},
}
We should document a "dynaconf specified" approach that our users could apply without having to modify the settings.py file directly (which they should never do).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing pulpcore/app/settings.py and the existing deprecation logger configuration. Document a Dynaconf-specified way for users to silence the pulpcore.deprecation warnings without editing settings.py directly; done means the documented configuration is clear and uses the supported settings mechanism.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100