fixed documentation issues introduced by PR #730

Author: alixdamman

larray/__init__.py

@@ -30,7 +30,7 @@
 from larray.inout.sas import read_sas
 from larray.inout.stata import read_stata
 from larray.inout.xw_excel import open_excel, Workbook
-from larray.inout.xw_reporting import ExcelReport
+from larray.inout.xw_reporting import ExcelReport, ReportSheet
 
 # just make sure handlers for .pkl and .pickle are initialized
 import larray.inout.pickle as _pkl
@@ -77,7 +77,7 @@
     # inout
     'from_lists', 'from_string', 'from_frame', 'from_series', 'read_csv', 'read_tsv',
     'read_eurostat', 'read_excel', 'read_hdf', 'read_sas', 'read_stata',
-    'open_excel', 'Workbook', 'ExcelReport',
+    'open_excel', 'Workbook', 'ExcelReport', 'ReportSheet',
     # utils
     'get_options', 'set_options',
     # viewer

larray/inout/xw_reporting.py

@@ -151,7 +151,7 @@ def graphs_per_row(self):
 
         See Also
         --------
-        :py:obj:``~AbstractSheetReport.newline`
+        ReportSheet.newline
         """
         return self._graphs_per_row
 
@@ -273,6 +273,9 @@ def add_graph(self, data, title=None, template=None, width=None, height=None):
     def add_graphs(self, array_per_title, axis_per_loop_variable, template=None, width=None, height=None,
                     graphs_per_row=1):
         r"""
+        Add multiple graph items to the current sheet. This method is mainly useful when multiple
+        graphs are generated by iterating over one or several axes of an array (see examples below).
+        The report Excel file is generated only when the :py:obj:`~ExcelReport.to_excel` is called.
 
         Parameters
         ----------
@@ -303,6 +306,8 @@ def add_graphs(self, array_per_title, axis_per_loop_variable, template=None, wid
         >>> sheet_pop = report.new_sheet('Population')
         >>> pop = demo.pop
 
+        Generate a new graph for each combination of gender and year
+
         >>> sheet_pop.add_graphs({'Population of {gender} by country for the year {year}': pop},
         ...                      {'gender': pop.gender, 'year': pop.time},
         ...                      template='line', width=450, height=250, graphs_per_row=2)
@@ -395,7 +400,7 @@ class AbstractExcelReport(AbstractReportItem):
 
     >>> sheet_countries.newline()
 
-    Add multiple graphs at once
+    Add multiple graphs at once (add a new graph for each combination of gender and year)
 
     >>> sheet_countries.add_graphs({'Population of {gender} by country for the year {year}': pop},
     ...                            {'gender': pop.gender, 'year': pop.time},