Skip to content

Conversation

surfingoldelephant
Copy link
Contributor

@surfingoldelephant surfingoldelephant commented Feb 24, 2025

PR Summary

This PR fixes incorrect automatic variable casing used throughout the documentation. E.g., $Args (incorrect) -> $args (correct).

This PR fixes all occurrences of:

  • $Error
  • $Event
  • $ExecutionContext

Context

This series of PRs ensures the correct case is consistently used for each individual automatic variable, as documented in about_Automatic_Variables and verified by tab completion.

Changes in scope:

  • Variables with a $ or @ sigil.
  • Variables referenced by name without a sigil.

Out of scope:

  • Preference variables (separate PRs to follow).
  • Misuse of an automatic variable (e.g., naming a function parameter as $Input).
  • Reference to the variable's value (e.g., false/False/FALSE when referring to the value of $false).

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

Copy link
Contributor

Learn Build status updates of commit 55b35d1:

✅ Validation status: passed

File Status Preview URL Details
.github/actions/.pwsh/module/functions/utility/Get-GHAConsoleError.ps1 ✅Succeeded
.github/actions/.pwsh/module/readme.md ✅Succeeded
reference/5.1/CimCmdlets/Register-CimIndicationEvent.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Prompts.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Scripts.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Utility/Register-EngineEvent.md ✅Succeeded View (powershell-5.1)
reference/7.4/CimCmdlets/Register-CimIndicationEvent.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_CommonParameters.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_Prompts.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_Scripts.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Utility/Register-EngineEvent.md ✅Succeeded View (powershell-7.4)
reference/7.5/CimCmdlets/Register-CimIndicationEvent.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_CommonParameters.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Prompts.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Scripts.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Utility/Register-EngineEvent.md ✅Succeeded View (powershell-7.5)
reference/7.6/CimCmdlets/Register-CimIndicationEvent.md ✅Succeeded View (powershell-7.6)
reference/7.6/Microsoft.PowerShell.Core/About/about_CommonParameters.md ✅Succeeded View (powershell-7.6)
reference/7.6/Microsoft.PowerShell.Core/About/about_Prompts.md ✅Succeeded View (powershell-7.6)
reference/7.6/Microsoft.PowerShell.Core/About/about_Scripts.md ✅Succeeded View (powershell-7.6)
reference/7.6/Microsoft.PowerShell.Utility/Register-EngineEvent.md ✅Succeeded View (powershell-7.6)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit e1056e3 into MicrosoftDocs:main Feb 24, 2025
4 of 5 checks passed
@surfingoldelephant surfingoldelephant changed the title Fix $Error, $Event and $ExecutionContext automatic variable case (2/13) Fix $Error, $Event and $ExecutionContext automatic variable case Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants