Skip to content

Commit 7f6e4c6

Browse files
Fix incorrect case/capitalization in ref docs
This ensures the following components have the correct/consistent case throughout the reference documentation: Preference variable, PS environment variable, PS drive, PS provider, PS command name, PS command argument, PS module, PS file extension, PS host name/application, #Requires statement, parameter name, about_* topic, member name, scope modifier, keyword, operator, calculated property key/value, attribute, type accelerator, type literal/name, WMI namespace/class, variable name, special character, comment-based help keyword, product/company name, Windows drive letter/directory, Windows/Unix environment variable In addition, changes include fixes to incorrect terminology (e.g., referring to a keyword as a command) and formatting of PS syntax elements (non-exhaustive).
1 parent 683ebdf commit 7f6e4c6

File tree

40 files changed

+174
-174
lines changed

40 files changed

+174
-174
lines changed

reference/docs-conceptual/community/2021-updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ New content
258258

259259
Content updates
260260

261-
- Converted [about_remote_faq](/powershell/scripting/learn/remoting/powershell-remoting-faq) to new
261+
- Converted [about_Remote_FAQ](/powershell/scripting/learn/remoting/powershell-remoting-faq) to new
262262
YAML format and moved to conceptual TOC
263263
- Moved **PSDesiredStateConfiguration** out of 7.2 docs and into PowerShell-Docs-Modules
264264
- DSC is being removed from PowerShell to become an optional module that is loaded from the

reference/docs-conceptual/community/community-update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ metadata:
88
description: A list of resources and a summary of new articles and community contributions. # < 160 chars
99
ms.topic: landing-page # Required
1010
author: sdwheeler #Required; your GitHub user alias, with correct capitalization.
11-
ms.author: sewhee #Required; microsoft alias of author; optional team alias.
11+
ms.author: sewhee #Required; Microsoft alias of author; optional team alias.
1212
ms.date: 02/03/2025
1313

1414
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn |

reference/docs-conceptual/community/contributing/labelling-in-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Area labels identify the parts of PowerShell or the documentation that the issue
5454
| `area-portability` | Cross-platform compatibility. |
5555
| `area-powershellget` | The [PowerShellGet][13] module. |
5656
| `area-providers` | PowerShell providers. |
57-
| `area-psreadline` | The [PSReadline][14] module. |
57+
| `area-psreadline` | The [PSReadLine][14] module. |
5858
| `area-release-notes` | The PowerShell release notes. |
5959
| `area-remoting` | The PowerShell remoting feature and cmdlets. |
6060
| `area-scriptanalyzer` | The [PSScriptAnalyzer][15] module. |

reference/docs-conceptual/dev-cross-plat/choosing-the-right-nuget-package.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ as the root module).
168168
When it comes to testing your module in .NET test runners like xUnit, remember that compile-time
169169
checks can only go so far. You must test your module against the relevant PowerShell platforms.
170170

171-
To test APIs built against PowerShell Standard in .NET, you should add `Microsoft.Powershell.SDK` as
171+
To test APIs built against PowerShell Standard in .NET, you should add `Microsoft.PowerShell.SDK` as
172172
a testing dependency with .NET Core (with the version set to match the desired PowerShell version),
173173
and the appropriate Windows PowerShell reference assemblies with .NET Framework.
174174

@@ -187,24 +187,24 @@ PowerShell installations or libraries.
187187
> The PowerShell SDK just refers to all the component packages that make up PowerShell, and which
188188
> can be used for .NET development with PowerShell.
189189
190-
A given `Microsoft.Powershell.SDK` version contains the concrete implementation of the same version
190+
A given `Microsoft.PowerShell.SDK` version contains the concrete implementation of the same version
191191
of the PowerShell application; version 7.0 contains the implementation of PowerShell 7.0 and running
192192
commands or scripts with it will largely behave like running them in PowerShell 7.0.
193193

194194
Running PowerShell commands from the SDK is mostly, but not totally, the same as running them from
195195
`pwsh`. For example, [Start-Job][10] currently depends on the `pwsh` executable being available, and
196-
so will not work with `Microsoft.Powershell.SDK` by default.
196+
so will not work with `Microsoft.PowerShell.SDK` by default.
197197

198-
Targeting `Microsoft.Powershell.SDK` from a .NET application allows you to integrate with all of
198+
Targeting `Microsoft.PowerShell.SDK` from a .NET application allows you to integrate with all of
199199
PowerShell's implementation assemblies, such as `System.Management.Automation`,
200200
`Microsoft.PowerShell.Management`, and other module assemblies.
201201

202-
Publishing an application targeting `Microsoft.Powershell.SDK` will include all these assemblies,
202+
Publishing an application targeting `Microsoft.PowerShell.SDK` will include all these assemblies,
203203
and any dependencies PowerShell requires. It will also include other assets that PowerShell required
204204
in its build, such as the module manifests for `Microsoft.PowerShell.*` modules and the `ref`
205205
directory required by [Add-Type][11].
206206

207-
Given the completeness of `Microsoft.Powershell.SDK`, it's best suited for:
207+
Given the completeness of `Microsoft.PowerShell.SDK`, it's best suited for:
208208

209209
- Implementation of PowerShell hosts.
210210
- xUnit testing of libraries targeting PowerShell reference assemblies.
@@ -215,7 +215,7 @@ be used as a module or otherwise loaded by PowerShell, but depends on APIs only
215215
particular version of PowerShell. Note that an assembly published against a specific version of
216216
`Microsoft.PowerShell.SDK` will only be safe to load and use in that version of PowerShell. To
217217
target multiple PowerShell versions with specific APIs, multiple builds are required, each targeting
218-
their own version of `Microsoft.Powershell.SDK`.
218+
their own version of `Microsoft.PowerShell.SDK`.
219219

220220
> [!NOTE]
221221
> The PowerShell SDK is only available for PowerShell versions 6 and up. To provide equivalent
@@ -225,7 +225,7 @@ their own version of `Microsoft.Powershell.SDK`.
225225
## System.Management.Automation
226226

227227
The `System.Management.Automation` package is the heart of the PowerShell SDK. It exists on NuGet,
228-
primarily, as an asset for `Microsoft.Powershell.SDK` to pull in. However, it can also be used
228+
primarily, as an asset for `Microsoft.PowerShell.SDK` to pull in. However, it can also be used
229229
directly as a package for smaller hosting scenarios and version-targeting modules.
230230

231231
Specifically, the `System.Management.Automation` package may be a preferable provider of PowerShell

reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ Import-Module ./bin/Debug/net8.0/myFeedbackProvider
449449
```
450450

451451
Once you're satisfied with your module, you should create a module manifest, publish it to the
452-
PowerShell Gallery, and install it in your `$env:PSModulePath`. For more information, see
452+
PowerShell Gallery, and install it in your `$Env:PSModulePath`. For more information, see
453453
[How to create a module manifest][01]. You can add the `Import-Module` command to your `$PROFILE`
454454
script so the module is available in PowerShell session.
455455

reference/docs-conceptual/dev-cross-plat/create-standard-library-binary-Module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ At this point, we can import our module with the psd1 file.
282282
Import-Module ".\Output\$module\$module.psd1"
283283
```
284284

285-
From here, we can drop the `.\Output\$module` folder into our `$env:PSModulePath` directory and it
285+
From here, we can drop the `.\Output\$module` folder into our `$Env:PSModulePath` directory and it
286286
autoloads our command whenever we need it.
287287

288288
### Update: dotnet new PSModule

0 commit comments

Comments
 (0)