Civilytics/uscogdata
3
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix stale test count and phantom notes column in cog_balances docs (#25)

Browse Source 
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).
This commit is contained in:
jared
2026-08-03 11:10:46 -04:00
parent b03f095e49
commit 225cd60968
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+1 -1
View File
@@ -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) **Version:** 0.1.0 (pre-release)
**Branch:** `main`, commit `d65e9fe` **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`) **CI:** Gitea Actions green (`.gitea/workflows/ci.yml`)
### Completed (Tasks 2.1–2.7) ### Completed (Tasks 2.1–2.7)
R/balances.R
+4 -4
View File
@@ -42,10 +42,10 @@
#' wide era to the modern one. #' wide era to the modern one.
#' #'
#' @return Tibble with columns `year`, `canonical_govid`, `gov_name`, #' @return Tibble with columns `year`, `canonical_govid`, `gov_name`,
#' `balance_subtype`, `category`, `amt_nominal`, optional #' `balance_subtype`, `category`, `amt_nominal`, `codes_included`,
#' `amt_per_capita_nominal` and `pop_source` (when `per_capita = TRUE`), #' `aggregate_fallback`, plus optional `amt_per_capita_nominal` and
#' optional `amt_real` and `amt_per_capita_real` (when `adjust_to_year` is #' `pop_source` (when `per_capita = TRUE`), and optional `amt_real` and
#' set), `codes_included`, `aggregate_fallback`, `notes`. Amounts are full #' `amt_per_capita_real` (when `adjust_to_year` is set). Amounts are full
#' US dollars. #' US dollars.
#' #'
#' Carries a `provenance` attribute matching #' Carries a `provenance` attribute matching
man/cog_balances.Rd
+4 -4
View File
@@ -47,10 +47,10 @@ wide era to the modern one.}
} }
\value{ \value{
Tibble with columns `year`, `canonical_govid`, `gov_name`, Tibble with columns `year`, `canonical_govid`, `gov_name`,
`balance_subtype`, `category`, `amt_nominal`, optional `balance_subtype`, `category`, `amt_nominal`, `codes_included`,
`amt_per_capita_nominal` and `pop_source` (when `per_capita = TRUE`), `aggregate_fallback`, plus optional `amt_per_capita_nominal` and
optional `amt_real` and `amt_per_capita_real` (when `adjust_to_year` is `pop_source` (when `per_capita = TRUE`), and optional `amt_real` and
set), `codes_included`, `aggregate_fallback`, `notes`. Amounts are full `amt_per_capita_real` (when `adjust_to_year` is set). Amounts are full
US dollars. US dollars.
Carries a `provenance` attribute matching Carries a `provenance` attribute matching