Merge pull request #2345 from python-gitlab/jlvillal/enable_debug

nejch · web-flow · commit 8f74a333ada3 · 2022-10-27T09:15:25.000+02:00
docs: add minimal docs about the `enable_debug()` method
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -50,6 +50,12 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab``
    # to validate your token authentication. Note that this will not work with job tokens.
    gl.auth()
 
+   # Enable "debug" mode. This can be useful when trying to determine what
+   # information is being sent back and forth to the GitLab server.
+   # Note: this will cause credentials and other potentially sensitive
+   # information to be printed to the terminal.
+   gl.enable_debug()
+
 You can also use configuration files to create ``gitlab.Gitlab`` objects:
 
 .. code-block:: python
