Skip to content
RichMorin edited this page Dec 30, 2012 · 6 revisions

Welcome to the Codeq Cookbook wiki!

This wiki is a Work In Progress; see the main page for its goals and Pages for a list of topics. This cookbook covers Codeq-specific recipes. For Datomic usage, in general, see datomic-cookbook.

Query Examples

Each query example page (eg, qx_commit-dates) documents a Codeq query, eg:

  • Problem - brief description of a problem (ie, use case)
  • Solution - example code and explanatory notes
  • Discussion - comments, notes, warnings, etc.
  • See Also - related pages in the wiki and elsewhere

The example code is carefully formatted and commented in an attempt to make it easy and (if possible) pleasant to read and comprehend, eg:

  • Every function has a docstring (documentation string).
  • Names (eg, symbols) are short, but carefully chosen.
  • Indentation clarifies the structure of the query.
  • In-line spacing presents query clauses in tabular form.
  • Comments on clauses provide a plausible "storyline".
  • Blank lines delimit sections and provide "breathing room".