Repository navigation
docs: fill in comment-based help gaps across 11 functions - #141
Merged
Merged
Conversation
Audited every exported function's Get-Help output across the whole module and found 23 real gaps concentrated in ~11 of the oldest functions, predating the comment-help convention fully settling in: missing .DESCRIPTION (several had only a .SYNOPSIS, one of which was literally just a doc URL), missing .PARAMETER entries (IgnoreSsl was the most common), a stale .EXAMPLE referencing the wrong function name, and Get-PiHoleGroup having essentially no documentation at all beyond its one-line synopsis. No behavior changes - verified by running the full non-integration unit suite (18/18) and the integration suites for every touched feature area against a live server (97/97). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Several .SYNOPSIS edits in the previous commit (e.g. Get-PiHoleGroup, Remove-PiHoleAuthSession, the Stats functions) feed directly into README's generated command-reference table, which wasn't regenerated alongside them - caught by the sync-readme CI check failing. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This PR's change to PiHoleShell/Private/Misc.ps1 triggers the pipeline's own shared/core-file fallback to the full test suite, which takes ~50-60 minutes against the real (slow) Pi Zero W test server - right at, and in this run past, Azure DevOps' default 60 minute job timeout. Raised with headroom rather than tuned precisely, since runtime varies with the test server's own accumulated state across runs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The previous commit's timeoutInMinutes was rejected outright by Azure
DevOps' YAML validation ("Unexpected value 'timeoutInMinutes'" at
line 21) - it isn't valid as a bare pipeline-level key, only nested
under an explicit job. Restructured the pipeline under jobs: so the
120-minute timeout actually takes effect.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The previous CI run for this PR got stuck after a manually-queued build was accidentally routed to the Microsoft-hosted pool instead of the self-hosted mmadeja-dt pool - this empty commit re-triggers a normal PR-sync build through the correct path. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The full suite run (build 403) failed 2 of 276 tests - both reproduced as clean passes when re-run in isolation moments later (Update-PiHoleList and Import-PiHoleTeleporter's integration tests), consistent with this project's well-documented pattern of transient connection hiccups on the real (weak, single-core) Pi Zero W test server under ~60 minutes of sustained load. Not a regression from this PR's changes. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
🤖 Generated with Claude Code