Skip to content

🪲 [Fix]: Fix issues with docs #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marius Storhaug (MariusStorhaug) merged 3 commits into from
Oct 6, 2025
Merged

🪲 [Fix]: Fix issues with docs #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32e0f7f
🩹 [Patch]: Enhance documentation for Test-Admin function with detaile…
MariusStorhaug Oct 6, 2025
491b930
🩹 [Patch]: Add Linter configuration to PSModule workflow for enhanced…
MariusStorhaug Oct 6, 2025
3d8bf10
Apply suggestion from @Copilot
MariusStorhaug Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/PSModule.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,12 @@ Test:
# Build:
# Docs:
# Skip: true
Linter:
env:
VALIDATE_BIOME_FORMAT: false
VALIDATE_BIOME_LINT: false
VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
VALIDATE_JSCPD: false
VALIDATE_JSON_PRETTIER: false
VALIDATE_MARKDOWN_PRETTIER: false
VALIDATE_YAML_PRETTIER: false
8 changes: 7 additions & 1 deletion src/functions/public/Test-Admin.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@
.SYNOPSIS
Test if the current context is running as a specified role.

.DESCRIPTION
This function checks if the current user context has Administrator privileges on Windows or is root on Unix-based systems.
It returns $true if the user has the required privileges, otherwise $false.

.EXAMPLE
Test-Role
```pwsh
Test-Admin
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example section should include the expected output to make it more helpful for users. Consider adding a line showing what the function returns, such as '$true' or '$false'.

Suggested change
Test-Admin
Test-Admin
# Output (if running as Administrator/root)
$true

Copilot uses AI. Check for mistakes.
```

Test if the current context is running as an Administrator.

Expand Down
Loading