Add documentation to fig,ax return in plot functions; no need to change examples

Author: robbievanleeuwen

sectionproperties/analysis/cross_section.py

@@ -44,7 +44,7 @@
 section.display_results()
 
 # plot the centroids
-fig, ax = section.plot_centroids()
+section.plot_centroids()
 
 stress_post.plot_stress_n_zz(pause=False)  # plot the axial stress
 stress_post.plot_stress_m_zz(pause=False)  # plot the bending stress

sectionproperties/examples/example_composite.py

@@ -33,4 +33,4 @@
 section.calculate_plastic_properties()
 
 # plot the centroids
-fig, ax = section.plot_centroids()
+section.plot_centroids()

sectionproperties/examples/example_custom.py

@@ -39,4 +39,4 @@
 section.calculate_plastic_properties(time_info=True, verbose=True)
 
 # plot the centroids
-fig, ax = section.plot_centroids()
+section.plot_centroids()

sectionproperties/examples/example_merged.py

@@ -33,4 +33,4 @@
 section.calculate_plastic_properties(time_info=True, verbose=True)
 
 # plot the centroids
-fig, ax = section.plot_centroids()
+section.plot_centroids()

sectionproperties/examples/example_mirr_rot.py

@@ -256,6 +256,9 @@ def plot_geometry(self, ax=None, pause=True, labels=False, perimeter=False):
         :param bool labels: If set to true, node and facet labels are displayed
         :param bool perimeter: If set to true, boldens the perimeter of the cross-section
 
+        :return: Matplotlib figure and axes objects (fig, ax)
+        :rtype: (:class:`matplotlib.figure.Figure`, :class:`matplotlib.axes`)
+
         The following example creates a CHS discretised with 64 points, with a diameter of 48 and
         thickness of 3.2, and plots the geometry::
 
@@ -334,6 +337,8 @@ def plot_geometry(self, ax=None, pause=True, labels=False, perimeter=False):
         if not ax_supplied:
             post.finish_plot(ax, pause, title='Cross-Section Geometry')
 
+        return (fig, ax)
+
     def calculate_extents(self):
         """Calculates the minimum and maximum x and y-values amongst the list of points.