From b4e9ab7ee395e575f17450c2dc0d519f7192e58e Mon Sep 17 00:00:00 2001 From: "John L. Villalovos" Date: Thu, 27 Oct 2022 00:03:24 -0700 Subject: [PATCH] docs: add minimal docs about the `enable_debug()` method Add some minimal documentation about the `enable_debug()` method. --- docs/api-usage.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 81834d235..444064b69 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