Elektra 0.11.0
keyString

Signature

const char *keyString(const Key *key)

Checklist

Doxygen

(bullet points are in order of appearance)

  • First line explains briefly what the function does
    • Get the pointer to the string representing the Key's value.
  • Simple example or snippet how to use the function
    • add example
  • Longer description of function containing common use cases
    • add explanation about pointers
    • add explanation about modifications from the user
  • Description of functions reads nicely
    • (null) -> "(null)"
    • (binary) -> "(binary)"
  • @pre
    • add?
  • @post
    • add?
  • @invariant
    • add?
  • @param for every parameter
    • move before return
    • key: key -> Key
  • @return / @retval
    • pointer to the string representing the Key's value
    • (null) -> "(null)"
    • (binary) -> "(binary)"
  • @since
    • add 1.0.0

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
  • Functions should have the least amount of parameters feasible

Structural Clarity

  • Functions should do exactly one thing
    • Return Values (null) and (binary)
  • 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

  • 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
    • "(null)" & "(binary)"

Tests

  • Function code is fully covered by tests
    • Line 198
    • Line 203
  • All possible error states are covered by tests
  • All possible enum values are covered by tests
  • No inconsistencies between tests and documentation

Summary

Think about changing the return values for 1.0.0. It seems like a hard step, but also inevitable to do at some point. Now would probably be better than in the future.

Other Issues discovered (unrelated to function)