From f96015097dad27bcd071c2e20ba6ada3a917cc5a Mon Sep 17 00:00:00 2001
From: Emmett Butler <723615+emmettbutler@users.noreply.github.com>
Date: Fri, 3 Nov 2023 12:49:44 -0700
Subject: [PATCH] doc: fix documentation of django trace_query_string
 configuration param (#7477)

This change fixes https://github.com/DataDog/dd-trace-py/issues/2991 by
updating the documentation of the configuration parameter
`config.django.http.trace_query_string` to match its actual behavior
encoded in the test suite.

This approach seems to be an appropriate fix because the issue ticket
uses existing documentation as a source of truth and doesn't articulate
any issues with the current behavior.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
- [x] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [x] This PR doesn't touch any of that.
---
 ddtrace/contrib/django/__init__.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ddtrace/contrib/django/__init__.py b/ddtrace/contrib/django/__init__.py
index dccaff35418..b76ff7a5b74 100644
--- a/ddtrace/contrib/django/__init__.py
+++ b/ddtrace/contrib/django/__init__.py
@@ -118,7 +118,7 @@
 
    Default: ``True``
 
-.. py:data:: ddtrace.config.django['trace_query_string']
+.. py:data:: ddtrace.config.django.http['trace_query_string']
 
    Whether or not to include the query string as a tag.