ksNew

• start = 2021-03-14 22:15
• end = 2021-03-14 22:35
• reviewer = Stefan Hanreich stefa.nosp@m.nhan.nosp@m.i@gma.nosp@m.il.c.nosp@m.om

Signature

KeySet *ksNew(size_t alloc, ...) ELEKTRA_SENTINEL

Checklist

Doxygen

(bullet points are in order of appearance)

• [x] First line explains briefly what the function does
• [ ] Simple example or snippet how to use the function
  
  • [ ] move up
• [x] Longer description of function containing common use cases
• [ ] Description of functions reads nicely
  
  • [ ] 'you should read the next statements' seems a bit strange
    
  • [ ] remove 'va the list of arguments' heading
• [ ] @pre
  
  • [ ] add
• [ ] @post
  
  • [ ] add more
• [ ] @invariant
  
  • [ ] add
• [ ] @param for every parameter
  
  • [ ] improve description for alloc: clarify hint
• [x] @return / @retval
• [ ] @since
  
  • [ ] add
• [ ] @ingroup
  
  • [ ] add
• [ ] @see
  
  • [ ] move to bottom
    
  • [ ] add keyNew()?
    
  • [ ] add ksVNew()?

Naming

• [ ] Abbreviations used in function names must be defined in the Glossary
  
  • [ ] define ks
• [x] Function names should neither be too long, nor too short
• [x] Function name should be clear and unambiguous
• [ ] Abbreviations used in parameter names must be defined in the Glossary
  
  • [ ] define ks
• [x] Parameter names should neither be too long, nor too short
• [ ] Parameter names should be clear and unambiguous
  
  • [ ] alloc -> size / initialSize

Compatibility

(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)

Parameter & Return Types

• [x] Function parameters should use enum types instead of boolean types wherever sensible
• [x] Wherever possible, function parameters should be const
• [x] Wherever possible, return types should be const
• [x] Functions should have the least amount of parameters feasible

Structural Clarity

• [x] Functions should do exactly one thing
• [x] Function name has the appropriate prefix
• [ ] Order of signatures in kdb.h.in is the same as Doxygen
• [ ] No functions with similar purpose exist
  
  • [ ] keyVNew()

Memory Management

• [x] Memory Management should be handled by the function wherever possible

Extensibility

• [x] Function is easily extensible, e.g., with flags
• [x] Documentation does not impose limits, that would hinder further extensions

Tests

• [x] Function code is fully covered by tests
• [ ] All possible error states are covered by tests
  
  • [x] see review for ksVNew() as this is a wrapper for this
• All possible enum values are covered by tests
• [x] No inconsistencies between tests and documentation

Summary

Other Issues discovered (unrelated to function)