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).
This commit is contained in:
@@ -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)
|
||||
|
||||
+4
-4
@@ -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
|
||||
|
||||
+4
-4
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user