Skip to content

consistency.md

Latest commit

 

History

History
34 lines (23 loc) · 551 Bytes

consistency.md

File metadata and controls

34 lines (23 loc) · 551 Bytes

Data Intellect KDB-X Module Consistency Guide

module Contents

Every module must have:

  1. The code
  2. Documentation in a .md file
  3. Tests, conforming to k4unit

The tests should be runnable as

q)k4unit:use`k4unit
q)k4unit.moduletest`module_to_test

Paths

Use module local paths for loading and file references

/ local loading
\l ::local/path/to/file.q

/ local path
get`:::local/path/to/datafile

Export

Only export the functions which should be called externally.

Namespaces

Avoid \d namespace switches.