Skip to content

Document belief_time_measured_instantly parameter in API #1708

@BelhsanHmida

Description

@BelhsanHmida

Currently, the API supports the parameter belief_time_measured_instantly=True when uploading data.
This ensures that the belief_time is set to immediately after the event ends (equivalently, sets belief_horizon = 0).

However, this parameter is undocumented.

Proposal

  • Add documentation for the belief_time_measured_instantly parameter in the API docs.
  • Clarify when to use it (e.g., when belief_time should coincide with event end).

Metadata

Metadata

Assignees

Labels

APIdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions