Annotation

[mtoy-googly-moogly]

Just a quick re-cap of things I have said and written elsewhere. I thought it would look something like this ...

Annotation uses the # symbol and MIGHT look like a tag cloud

# fooTag barTag blechTag=someString
source: taggedSource is untaggedSource

Would some sort of tag data to the StructDef, maybe ...

{
  type: "struct",
  as: "taggedSource",
  annotation: {
    fooTag: true,
    barTag: true,
    blechTag: "someString"
  }
}

Annotation MIGHT also just be JSON

There is some way to just straight write JSON .. ( or non key quoted json )

#{
  someComplexValue: [ { } { } ],
  fooTag: true
#}

Annotation works with refinement

There is some way to control how tags are inherited

# -tagIWantDeleted
source: withoutTag is withTag

Otherwise tags are merged.

Many things can be tagged

Fields and queries can also be tagged.

source: a is b + {
  measure:
    # isMoney
    profit is sales_price - cost
 }

Questions

Tag AFTER or BEFORE item ...

  measure: foo is bar # tagFoo

I like the way this reads better than

  measure:
    # tagFoo
    foo is bar

Types?

In this world tags are untyped data blobs ... maybe there is typing in annotation somehow?

Dots ...

Maybe it makes sense to allow dotted names, in order to make some namespace managment possible

# composer.foo=bar

=>

annotation: {
  composer: {
    foo: bar
  }
}

More things in "simple tags" than strings

• Arrays? # arrayTag=[red,blue,green]

But beyond that maybe then you need to use #{

Docstrings?

Shouldn't documentation metadata also somehow be in tags? Maybe docstrings come before and tags come after ...

#" Goodness is a measure we use to sort events
#" It is vague and undefined except that negative values are considered "evil"
dimension: goodness is postiiveEffect - negativeConsequences # tagForGoodness

=>

{
  type: "number",
  name: "goodness",
  annotation: { tagForGoodness: true },
  docString: 'Goodness is a measure we use to sort events\nIt is vague and undefined except that negative values are considered "evil"'

[mtoy-googly-moogly]

implemented