Skip to content

Document the internal architecture and code structure #123

Description

@apdavison

The generated fairgraph.openminds modules are documented, but the hand-written core is not: base.py, node.py,kgobject.py, embedded.py, kgproxy.py, kgquery.py, collection.py, client.py, queries.py, registry.py, caching.py, utility.py, nor the builder/ pipeline that generates the openMINDS classes and merges the hand-written method overlays.

Worth covering: the KGNode/NodeMeta layer, how the registry substitutes fairgraph classes for openMINDS ones, how queries.py turns properties into KG query JSON, and the forward-versus-reverse property distinction.

This is developer material, so it belongs alongside the Developers' Guide rather than in the user documentation (e.g., a user querying the KG has no need to know the registry exists).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions