Elektra 0.11.0
keySetName

Signature

ssize_t keySetName(Key *key, const char *newname)

Checklist

Doxygen

(bullet points are in order of appearance)

  • First line explains briefly what the function does
  • Simple example or snippet how to use the function
    • add
  • Longer description of function containing common use cases
  • Description of functions reads nicely
  • @pre
    • Precondition
      newName must be a valid name
    • Precondition
      must not be a read-only key
    • Precondition
      must not have been inserted before
  • @post
    • Postcondition
      Key has (possibly modified) newName as name
  • @invariant
    • add
  • @param for every parameter
  • @return / @retval
    • add @retval -1 if key is read-only
  • @since
    • add
  • @ingroup
  • @see
    • add keySetNameSpace()

Naming

  • 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

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

  • 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
    • might be possible to make it const
  • Functions should have the least amount of parameters feasible

Structural Clarity

  • Functions should do exactly one thing
  • Function name has the appropriate prefix
  • Order of signatures in kdb.h.in is the same as Doxygen
    • swapped with functions for unescaped
  • No functions with similar purpose exist

Memory Management

  • Memory Management should be handled by the function wherever possible

Extensibility

  • Function is easily extensible, e.g., with flags
  • Documentation does not impose limits, that would hinder further extensions
    • behavior on invalid names

Tests

  • Function code is fully covered by tests
    • test_bit "CANNOT" fail, so might not be necessary to cover this
      for now should be made more resistant to future changes
  • All possible error states are covered by tests
    • test read-only keys
  • All possible enum values are covered by tests

Summary

Other Issues discovered (unrelated to function)