akveo / akveo/ng2-smart-table

Please update documentation for setting properties that are functions.

Open
#402 1 comment 9 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1.6k
Forks
867
PR merge metrics
No merged PRs in 30d

Description

Column settings that take functions as values need to be better documented.
For example for compareFunction there is no indications for what the input will be nor what the output should be. (if anyone is wondering here is the default compare :
`protected static COMPARE = (direction: any, a: any, b: any) => {
if (a < b) {
return -1 * direction;
}
if (a > b) {
return direction;
}
return 0;
}
`)

This is also the case for the property filterFunction.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.