Skip to content

Document the relationship between EvalState and Store #6

@Radvendii

Description

@Radvendii

Our EvalState has an associated Store, and it's not clear what's going on there. IIUC, the underlying C code has a similar structure. Maybe in theory the EvalState could have multiple stores associated with it, but at the moment that's not how it works in practice. Also, in theory we could have one Store associated with multiple EvalStates, but in practice it doesn't actually matter, because Store is already a smart pointer to an underlying c struct, and can be cloned.

Places that should maybe have documentation:

  • The Store field of the EvalState struct.
  • The store() method on EvalState, answering the question "why is this a function and people not just directly access the field?" answer: "the field is an implementation detail, you could get the same information by calling a function from the c api"

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