a-marenkov / gsheets

A Dart library for working with Google Sheets API.
Other
82 stars 31 forks source link

ValuesMapper.rowByKey() default value for fromColumn not matching documentation #98

Open the-berni opened 11 months ago

the-berni commented 11 months ago

In the ValuesMappe.rowByKey() method the documentation states, the default value for fromColumn as 1 but indeed it is 2.

/// Fetches row by its name, maps it to other row, and returns map. /// /// Expands current sheet's size if requested range is out of sheet's bounds. /// /// The column A considered to be row names /// /// [key] - name of a requested row (values of returned map) /// /// [fromColumn] - optional (defaults to 1), index of a column that requested row /// starts from (values before [fromColumn] will be skipped), /// columns start at index 1 (column A) /// /// [length] - optional (defaults to -1), the length of a requested row /// if length is -1, all values starting from [fromColumn] will be returned /// /// [mapTo] - optional, name of a row to map values to (keys of returned /// map), if [mapTo] is null then values will be mapped to first row, /// rows start at index 1 /// /// Returns row as Future [Map] of [String] to [String]. /// /// Throws [GSheetsException]. Future<Map<String, String>?> rowByKey( Object key, { int fromColumn = 2, int length = -1, dynamic mapTo, }) ....