Skip to content

docs: document the reserved v{i}_ posterior-variable prefix for adapter authors #182

Description

@thomaspinder

Found during review of #176 (issue #142). assign_blocks routes any ^v\d+_ posterior variable to the volatility block, so a hand-built variable named e.g. v2_gdp would be misattributed (cosmetic). The convention is stated in ADR-0008 but not in the VolatilityProcess protocol docstring where adapter authors would see it. One sentence in protocols.py.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions