chore: add `pprint()` and `pformat()` methods to RESTObjectjlvillal/pprint

This is useful in debugging and testing. As can easily print out the
values from an instance in a more human-readable form.

1 files changed, 11 insertions, 0 deletions

diff --git a/docs/api-usage.rst b/docs/api-usage.rst
index 66e5887..a544bdd 100644
--- a/docs/api-usage.rst
+++ b/docs/api-usage.rst
@@ -179,6 +179,17 @@ resources. For example:
    project = gl.projects.get(1)
    project.star()
 
+You can print a Gitlab Object. For example:
+
+.. code-block:: python
+
+   project = gl.projects.get(1)
+   print(project)
+   # Or in a prettier format. These two are equivalent.
+   print(project.pformat())
+   project.pprint()
+
+
 Base types
 ==========