Skip to main content

Module reviews

Module reviews 

Source
Expand description

How each day went, as you said it (docs/reviews.md): the morning’s weather, the review at the end of the work day (“Done for today”) and the one before sleep, each with how the day felt, its mix and a note, every answer optional. Kept readable in $XDG_DATA_HOME/sioul/reviews/YYYY-MM.toml, one table per date, and shared with the sharing’s “time” part, with the plan’s other files: every device learns the same.

The plan learns from the day’s outcome (Day::outcome, criteria CB13–14 and G7 of docs/research/): a day without one counts for nothing. Nothing here is counted, scored or compared: the words are shown as said.

Structs§

Day
One day: the morning’s weather, as said, and its two reviews.
Moment
Where the day stands, for the offer.
Offer
What the status line offers now (docs/reviews.md).
Review
One review: when it was given, and what was said, each answer optional. Given with nothing said, it says the day was closed without a word.
Reviews
Every day kept, by date.

Enums§

Felt
How the day felt: the words a task has for what it takes.
Kind
Which review: at the end of the work day, or before sleep (the whole day).
Mix
The day’s mix of duty and what is yours (G7): too much, about right, too empty.

Constants§

CORRECTION
A weather said again within this long of the first is a correction, not a change.
DAY_TURNS
Without a night set, a day closed before this hour is the day before.
EVENING
The evening: this long before the night’s wind-down (an informed guess).
EVENING_ENDS
EVENING_FROM
Without a night set, the evening runs from this hour to EVENING_ENDS (guesses).

Functions§

back_line
A past day in one line, as it was said: “Morning: haze · End of work: heavy; the mix: about right · The day: usual”.
change 🔒
Changes one date’s table in its month file, the rest of the file kept as written (comments, what a newer Sioul adds); under the file’s lock, as the sharing writes in it too. A file that does not read is never written over.
day_of 🔒
month_of 🔒
“2026-10.toml” → (2026, 10); hidden and other files are none.
month_path
The file a date is kept in.
morning_lines
How the day started and what the plan did with it, in words, only what was said: “This morning: haze. The plan kept a lighter day.” Nothing when the weather was never said.
night_day
The day a night belongs to: the evening it starts, or, its bedtime (bed, Unix seconds) before noon, the evening before (Health’s night_of).
note_weather
The weather said for date at at (Unix seconds): the morning’s when it is the first, or a correction within CORRECTION of it; else a change later in the day, forgotten when it comes back to the morning’s.
offer
What the status line offers now: closing the work day once today’s last hours of work or admin are over, until the evening; then closing the day, once the work day is over. Nothing while you sleep (the wind-down included) or work, nor once that review is given; the next morning never opens on yesterday.
offer_any_time
What offer would offer whatever the time now is for: for the notice “Work hours are over”, whose times are the notification matrix’s to say (notify; as usual, those of offer).
read_month 🔒
One month’s days; none when the file is not there.
review_of 🔒
said_words
What a review said, in words: “heavy; the mix: too much”; “a note” when only a note was written; none when nothing was said.
save
Keeps a review of date, whole: given again, it replaces the one before.
say 🔒
stamp_of 🔒
A time as files may hold it: RFC 3339 text (as written here), a TOML date-time written by hand, or Unix seconds.
stamp_text 🔒
A time as written here: “2026-10-06T17:04:12+02:00”, in zone.
weather_id 🔒
weather_of 🔒
weather_word 🔒