int keyIsBelowOrSame(const Key *key, const Key *check)
(bullet points are in order of appearance)
- [ ] First line explains briefly what the function does
- [ ] Simple example or snippet how to use the function
- [ ] Longer description of function containing common use cases
- [ ] Description of functions reads nicely
- [ ]
@pre
- [ ]
@post
- [ ]
@invariant
- [ ]
@param for every parameter
- [ ]
@return / @retval
- [ ]
@since
- [ ] `
[ ]- See also
- `
- [ ] Abbreviations used in function names must be defined in the Glossary
- [ ] Function names should neither be too long, nor too short
- [ ] Function name should be clear and unambiguous
- [ ] Abbreviations used in parameter names must be defined in the Glossary
- [ ] Parameter names should neither be too long, nor too short
- [ ] Parameter names should be clear and unambiguous
(only in PRs)
- [ ] Symbol versioning is correct for breaking changes
- [ ] ABI/API changes are forward-compatible (breaking backwards-compatibility to add additional symbols is fine)
- [ ] Function parameters should use enum types instead of boolean types wherever sensible
- [ ] Wherever possible, function parameters should be
const
- [ ] Wherever possible, return types should be
const
- [ ] Functions should have the least amount of parameters feasible
- [ ] Functions should do exactly one thing
- [ ] Function name has the appropriate prefix
- [ ] Order of signatures in kdb.h.in is the same as Doxygen
- [ ] No functions with similar purpose exist
- [ ] Memory Management should be handled by the function wherever possible
- [ ] Function is easily extensible, e.g., with flags
- [ ] Documentation does not impose limits, that would hinder further extensions
- [ ] Function code is fully covered by tests
- [ ] All possible error states are covered by tests
- [ ] All possible enum values are covered by tests
- [ ] No inconsistencies between tests and documentation
