Skip to content

Commit

Permalink
Update columns-API.md - remove confusing wording, closes #421
Browse files Browse the repository at this point in the history
  • Loading branch information
@johanneswilm
johanneswilm authored Feb 12, 2025
1 parent 50da3a5 commit d3f1c1d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/documentation/columns-API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can then chain the following methods.

### `get(column [integer])`

Fetch read-only data about the column at index `column`. The `column` parameter should be a non-zero-based integer.
Fetch read-only data about the column at index `column`. The `column` parameter should be an integer representing the column.

---

Expand All @@ -26,7 +26,7 @@ Fetch the number of columns.

### `sort(column [integer], direction [string])`

Sort the selected column. The `column` parameter should be a non-zero-based integer. The `direction` parameter is optional.
Sort the selected column. The `column` parameter should be an integer representing the column. The `direction` parameter is optional.

---

Expand Down

1 comment on commit d3f1c1d

@esabol
Copy link
Contributor

@esabol esabol commented on d3f1c1d Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. While the documentation is no longer incorrect after this change, it's also not very informative. I suggest changing "an integer representing the column" to "an integer representing the column, starting with zero for the first column."

Please sign in to comment.