Task: Deepen the analytic parameter texts

Table of Contents

This page documents a task in the See and change everything a report runs story. It captures the goal, current status, acceptance, and any notes or results.

1. Goal

The analytic parameters that a report screen shows first have a description of the depth of the implyTodaysFixings text, with examples.

2. Status

Field Value
State DONE
Parent story See and change everything a report runs
Now Nothing.
Waiting on Nothing.
Next Nothing.
Last touched 2026-10-23

3. Acceptance

  • The npv, cashflow, curves, simulation, xva, sensitivity and stress parameters have descriptions of about 500 characters, with an example where it helps.
  • The texts stay accurate to the sources, and the seed check passes.

4. Plan

(Implementation strategy. Written when work starts; key decisions are distilled into the parent story's * Decisions at close, but the plan itself stays — it is the historical record of what we did.)

5. Measurements

Every number this task claims about a tree, with the command that produced it and the commit it was measured at. A number without both is not a measurement, because a clean-up record describes a tree and trunk moves under a branch: a consumer count, a gate's component count and a suite's size all change with no code changing, and the reader of a bare number cannot tell which tree it came from. Where the raw output matters, put it in an evidence/ file beside the task and name that file in the Command column.

What Value Command Commit
       

6. Notes

7. Test Scenarios

Manual QA scenarios (scaffolded via compass add test_scenario) that verify this task. Link new ones here as they're created; the scenario doc itself links back via its "Verifies task" field.

Scenario State Notes
     

8. PRs

PR Title
#3650 [reporting] Deepen the analytic ORE parameter texts

9. Review

Comment summary File Decision Notes
       

10. Result

About 230 analytic parameter texts are deeper. Each one now says what the parameter decides, what its values do or what it changes in the results, when to change it, and an example where one helps. The median description grew from 193 to 289 characters, and the number of descriptions under 200 characters fell from 276 to 47.

The 47 that stay short are the parameters that ORE ignores or no longer reads. A longer text for them would be padding, so they say plainly that ORE ignores them.

The facts come from the ORE user guide, the example files and the ORE source at tag v1.8.17.0. Where the source did not settle a point, the text says less. A reviewer who knows ORE should still read the texts for the capital and margin analytics.

Emacs 29.3 (Org mode 9.6.15)