Developers guide

Style Guide

Follow the julia style guide as much as possible: https://docs.julialang.org/en/v1/manual/style-guide/index.html

Structs

Often used structs with get/set methods should be documented in the field,eg:

"""
$(TYPEDEF)
Complete variable structure for a DistributedFactorGraph variable.

  ---
Fields:
$(TYPEDFIELDS)
"""
struct DFGVariable{T<:InferenceVariable} <: AbstractDFGVariable
    """Variable label, e.g. :x1.
    Accessor: `getLabel`"""
    label::Symbol
    """Variable timestamp.
    Accessors: `getTimestamp`, `setTimestamp!`"""
...