From ac9f0a553209278df25634c3b1923dc6bc41eed9 Mon Sep 17 00:00:00 2001 From: aaron-jack-manning Date: Tue, 30 Aug 2022 19:57:52 +1000 Subject: [PATCH] formatting of invariants file --- dev-notes/data invariants.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/dev-notes/data invariants.md b/dev-notes/data invariants.md index 74de536..5f35800 100644 --- a/dev-notes/data invariants.md +++ b/dev-notes/data invariants.md @@ -2,19 +2,19 @@ This file contains notes on invariants which must be upheld across running toru commands for the vault and configuration. -# tasks::Task +### tasks::Task - name cannot be purely numeric - ID must be unique -# tasks::Duration +### tasks::Duration - minutes should be less than 60 -# state::State (in state.toml) +### state::State (in state.toml) - the `next_id` should always be greater than the ID of any task within the vault -# index::Index (in state.toml) +### index::Index (in state.toml) - the index of name to ID map should be correct given the names and IDs of all vaults -# graph::Graph (in state.toml) +### graph::Graph (in state.toml) - should always have dependencies the same as specified in each task file - no circular dependencies should be allowed to exist between tasks (and by extension should not exist in the state file)