From 225cd609683ad520ea3af22ed65fff0084a472c5 Mon Sep 17 00:00:00 2001 From: Jared Knowles Date: Mon, 3 Aug 2026 11:10:46 -0400 Subject: [PATCH] docs: fix stale test count and phantom notes column in cog_balances docs (#25) Re-measured CLAUDE.md's test count on the final tree (764, not 763 -- the earlier number predated the balance_caveats schema test). Removed notes from cog_balances()'s @return block: it was copied from cog_spending()'s @return style without checking cog_balances() never calls .verb_spendrev(), the only place that sets notes. Verified the remaining documented columns against colnames() observed across every argument combination (bare, per_capita, adjust_to_year, both, recipe, category filter). --- CLAUDE.md | 2 +- R/balances.R | 8 ++++---- man/cog_balances.Rd | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 51b0ee7..6a88b54 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -64,7 +64,7 @@ Any value without `://` is treated as a local path by `.is_local_path()` and rea **Version:** 0.1.0 (pre-release) **Branch:** `main`, commit `d65e9fe` -**Tests:** 763 PASS / 0 FAIL / 0 SKIP (measured `testthat::test_local()`, 2026-08-03) +**Tests:** 764 PASS / 0 FAIL / 0 SKIP (measured `testthat::test_local()`, 2026-08-03, on the tree including the balance_caveats schema test) **CI:** Gitea Actions green (`.gitea/workflows/ci.yml`) ### Completed (Tasks 2.1–2.7) diff --git a/R/balances.R b/R/balances.R index f521a7f..5f755f3 100644 --- a/R/balances.R +++ b/R/balances.R @@ -42,10 +42,10 @@ #' wide era to the modern one. #' #' @return Tibble with columns `year`, `canonical_govid`, `gov_name`, -#' `balance_subtype`, `category`, `amt_nominal`, optional -#' `amt_per_capita_nominal` and `pop_source` (when `per_capita = TRUE`), -#' optional `amt_real` and `amt_per_capita_real` (when `adjust_to_year` is -#' set), `codes_included`, `aggregate_fallback`, `notes`. Amounts are full +#' `balance_subtype`, `category`, `amt_nominal`, `codes_included`, +#' `aggregate_fallback`, plus optional `amt_per_capita_nominal` and +#' `pop_source` (when `per_capita = TRUE`), and optional `amt_real` and +#' `amt_per_capita_real` (when `adjust_to_year` is set). Amounts are full #' US dollars. #' #' Carries a `provenance` attribute matching diff --git a/man/cog_balances.Rd b/man/cog_balances.Rd index f3e40b9..9b96b97 100644 --- a/man/cog_balances.Rd +++ b/man/cog_balances.Rd @@ -47,10 +47,10 @@ wide era to the modern one.} } \value{ Tibble with columns `year`, `canonical_govid`, `gov_name`, - `balance_subtype`, `category`, `amt_nominal`, optional - `amt_per_capita_nominal` and `pop_source` (when `per_capita = TRUE`), - optional `amt_real` and `amt_per_capita_real` (when `adjust_to_year` is - set), `codes_included`, `aggregate_fallback`, `notes`. Amounts are full + `balance_subtype`, `category`, `amt_nominal`, `codes_included`, + `aggregate_fallback`, plus optional `amt_per_capita_nominal` and + `pop_source` (when `per_capita = TRUE`), and optional `amt_real` and + `amt_per_capita_real` (when `adjust_to_year` is set). Amounts are full US dollars. Carries a `provenance` attribute matching