finprint.describe

module finprint

Plain-language summary of a recipe (finprint show): “Dropped 2 rows: 156 to 154”, “Added spend_net”.

Functions

describe_step

function

def describe_step(step: RecipeStep, names: dict[str, str], *, tags: bool = True) -> str

One step in words. tags adds the terminal’s [cell N] and [not replayable] markers; a page that shows the cell and replayability on their own leaves them off.

Source: packages/finprint/src/finprint/describe.py, line 222

describe

function

def describe(recipe: TransformRecipe) -> list[str]

The step list in words, one line per step.

Source: packages/finprint/src/finprint/describe.py, line 246

summary

function

def summary(recipe: TransformRecipe) -> str

Multi-line text for finprint show.

Source: packages/finprint/src/finprint/describe.py, line 252

Constants

Name	Type	Value	Description
STATUS_WORDS		{'not_checked': 'Not checked', 'reproduced': 'Reproduced', 'not_reproduced': ...