summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn L. Villalovos <john@sodarock.com>2022-10-27 00:03:24 -0700
committerJohn L. Villalovos <john@sodarock.com>2022-10-27 00:03:24 -0700
commitb4e9ab7ee395e575f17450c2dc0d519f7192e58e (patch)
tree73d4d4aa4098467421b9cee989e016eaa0fe2d21
parenta3b482459d1e2325bf9352a0ee952b35a38f7e32 (diff)
downloadgitlab-b4e9ab7ee395e575f17450c2dc0d519f7192e58e.tar.gz
docs: add minimal docs about the `enable_debug()` method
Add some minimal documentation about the `enable_debug()` method.
-rw-r--r--docs/api-usage.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
index 81834d2..444064b 100644
--- 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