➹ Jolly 1.0.0-rc.3  –  API documentation

Definition of the Bar type `::examples`.

## Model

Bars of this type can hold examples taken from a **Grimoire** data store. For
the shape, see the Schema below.

 - `:name` is the name of the example. – We take this from lib-grimoire, so
   it's probably the file name and won't be fancy.

 - The `:name` of an example and the coordinates of the Thing it is attached
   to are expected to uniquely identify the example within one version of a
   Grenada artifact.

 - The `:contents` are simply the data returned by
   clj::grimoire.api/read-example (minus `Success` wrapper).

## Prerequisites

None. Can be attached to any Thing.

## Remarks

Grimoire examples have a handle, which in the FS implementation is their
absolute path, as far as I understand. And they are `assoc`ed with their path
relative to the root of the examples store. This doesn't make much sense to
me. The handle is supposed to be unique, but if it's an absolute path on the
individual machine, it's too unique. And the relative path is redundant with
the parent field. I guess these things are required internally, but they're
not helpful in a Datadoc JAR, which is why I leave them out.

Definition of the Bar type `::notes`.

## Model

Bars of this type can hold notes taken from a **Grimoire** data store. For the
shape, see the Schema below.

Apart from the different meaning, Grimoire notes are nearly the same as
Grimoire examples. See clj::jolly.bars/examples-def and substitute 'example'
with 'note' where appropriate.