Skip to content

Update/audit ANNIEEvent documentation #377

@mastbaum

Description

@mastbaum

One comment I have is that the "ANNIEEvent" has a well-defined format. Does the new event builder change that format? There seem to be variables being populated that I couldn't spot in the Google doc.
If so, it should be documented - clearly stating what the new variables are, what, if anything, is now deprecated, along with updating (or replacing) the associated Google Doc. If there are format changes we should also discuss and document whether there are breaking changes that need updates to, or that deprecate, other Tools.
Also, while i'm not sure whether it's really feasible with the way event building works, is it possible that other Tools might be developed that also add information to the ANNIEEvent? Should it maybe put it into the DataModel to enable that?

Originally posted by @marc1uk in #337 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions