worksheet.worksheet iter_rows and iter_cols max_row doc-string incorrectly specified as 'smallest row index'

Issue #1095 resolved
Jason Fuller
created an issue

In both the source and 'read-the-docs' max_row is defined as the smallest row index, when max_row should be defined as the largest row index

iter_cols source:

 def iter_cols(self, min_col=None, max_col=None, min_row=None, max_row=None):
        """
        Produces cells from the worksheet, by column. Specify the iteration range
        using indices of rows and columns.

        If no indices are specified the range starts at A1.

        If no cells are in the worksheet an empty tuple will be returned.

        :param min_col: smallest column index (1-based index)
        :type min_col: int

        :param min_row: smallest row index (1-based index)
        :type min_row: int

        :param max_col: largest column index (1-based index)
        :type max_col: int

        :param max_row: smallest row index (1-based index)
        :type max_row: int

        :rtype: generator
        """

Change iter_cols source to:

        :param max_row: largest row index (1-based index)
        :type max_row: int

iter_rows source:

    def iter_rows(self, range_string=None, min_row=None, max_row=None, min_col=None, max_col=None,
                  row_offset=0, column_offset=0):
        """
        Produces cells from the worksheet, by row. Specify the iteration range
        using indices of rows and columns.

        If no indices are specified the range starts at A1.

        If no cells are in the worksheet an empty tuple will be returned.

        :param range_string: range string (e.g. 'A1:B2') *deprecated*
        :type range_string: string

        :param min_col: smallest column index (1-based index)
        :type min_col: int

        :param min_row: smallest row index (1-based index)
        :type min_row: int

        :param max_col: largest column index (1-based index)
        :type max_col: int

        :param max_row: smallest row index (1-based index)
        :type max_row: int

        :param row_offset: added to min_row and max_row (e.g. 4)
        :type row_offset: int

        :param column_offset: added to min_col and max_col (e.g. 3)
        :type column_offset: int

        :rtype: generator
        """

change iter_rows source to:

 :param max_col: largest column index (1-based index)
 :type max_col: int

Comments (5)

  1. Log in to comment