DOC: document return from get_tight_layout_figure

jklymak · jklymak · commit a687aaf8c562 · 2018-10-15T15:41:25.000-07:00
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -38,7 +38,8 @@ API Changes for 3.0.1
 
 `.tight_layout.auto_adjust_subplotpars` can return ``None`` now if the new
 subplotparams will collapse axes to zero width or height.  This prevents
-``tight_layout`` from being executed.  
+``tight_layout`` from being executed.  Similarly
+`.tight_layout.get_tight_layout_figure` will return None.  
 
 API Changes for 3.0.0
 =====================
diff --git a/lib/matplotlib/tight_layout.py b/lib/matplotlib/tight_layout.py
@@ -290,6 +290,13 @@ def get_tight_layout_figure(fig, axes_list, subplotspec_list, renderer,
         (left, bottom, right, top) rectangle in normalized figure coordinates
         that the whole subplots area (including labels) will fit into.
         Defaults to using the entire figure.
+
+    Returns
+    -------
+    subplotspec or None
+        subplotspec kwargs to be passed to `.Figure.subplots_adjust` or
+        None if tight_layout could not be accomplished.  
+
     """
 
     subplot_list = []
