Skip to content

docs(ps1): Get-ValidAccounts and Get-Categories .PARAMETER name ReceiptsRoot is misleading -- should be ConfigRoot #141

Description

@ndomako10

Finding

In Scripts/Sync-Receipts.ps1, both `Get-ValidAccounts` (line 364, param at line 377) and `Get-Categories` (line 487, param at line 498) expose a parameter named `$ReceiptsRoot` whose purpose is a config directory path (not the receipts root). Both functions are called at line 1633 and 1648 with `-ReceiptsRoot $ConfigRoot`. `Get-Methods` correctly names the same-purpose parameter `$ConfigRoot` (line 434/444). The .PARAMETER help blocks and the parameter names are internally inconsistent with the rest of the codebase.

Impact

Callers passing `-ReceiptsRoot` to these functions when they mean the config root will be confused, and anyone extending the code may propagate the wrong name further.

Fix

Rename `$ReceiptsRoot` to `$ConfigRoot` in both `Get-ValidAccounts` and `Get-Categories` param blocks, update their `.PARAMETER` doc blocks, and update the two call sites (lines 1633, 1648).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions