Skip to content

Conversation

@sdwheeler
Copy link
Collaborator

@sdwheeler sdwheeler commented Jan 5, 2026

PR Summary

Define common terminology and styling

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 contributor's guide.
  • Style: This PR adheres to the style guide.

Copilot AI review requested due to automatic review settings January 5, 2026 16:14
@learn-build-service-prod

This comment was marked as outdated.

@sdwheeler
Copy link
Collaborator Author

@surfingoldelephant Please review and comment. We can build on this document.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces a new terminology guidelines document for PowerShell documentation to ensure consistency across documentation. The document covers common terminology, styling conventions, and formatting rules that will eventually be incorporated into the PowerShell-Docs Style Guide.

  • Establishes terminology standards for null values, boolean values, hash tables, and PowerShell language constructs
  • Defines hyphenation, capitalization, and spacing conventions for PowerShell-specific terms
  • Provides guidance on distinguishing between similar concepts (declare vs. initialize, native vs. external commands, scalar vs. single vs. singleton)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 2d052a0:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

1 similar comment
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

sdwheeler and others added 2 commits January 5, 2026 12:57
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 5be5a08:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit d8fea64:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

terminology.md Outdated
Comment on lines 109 to 112
PowerShell has no concept of declaring variables, unless you count using `New-Variable` as a
declaration. Even then, the new variable is given a default value. Essentially, variables are
declared on first use. If the variable was not assigned a value, it is initialized to a default
value depending on its type.
Copy link
Contributor

Choose a reason for hiding this comment

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

New-Variable -Name Foo creates a new variable $foo with a value of $null. Are we considering $null as a "default value" in this case?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fair point. After looking at it more closely, New-Variable doesn't allow you to specify a type. So, basically, this is the only way to declare a variable without initialization. I will reword this.

Comment on lines +162 to +163
- Use _hashtable_ (all lowercase) when referring to the PowerShell objects of type `[hashtable]`.
May be capitalized as _Hashtable_ when it begins a sentence.
Copy link
Contributor

Choose a reason for hiding this comment

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

Based on this, does about_Hash_Tables need to be renamed to about_Hashtables?

Copy link
Collaborator Author

@sdwheeler sdwheeler Jan 6, 2026

Choose a reason for hiding this comment

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

Technically, yes. But practically, no. Update-Help doesn't have a way to rename files. If you have help already installed you end up with both files. So we can't really rename about_ files.


- A _statement block_ to refers to `{}` expressions in a statement. This is how the AST refers to
them. Statement blocks don't take parameters or create new scopes.
- _scriptblock_ should be used to refer to `{}` expressions of type `[scriptblock]`. For example,
Copy link
Contributor

Choose a reason for hiding this comment

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

Similar to above. about_Script_Blocks will need to be renamed to about_Scriptblocks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Same answer

_Native commands_ are executables that can be run from any shell or other invocation method
supported by the OS.

### Scalar vs. single vs. singleton
Copy link
Contributor

@surfingoldelephant surfingoldelephant Jan 6, 2026

Choose a reason for hiding this comment

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

"Scalar" is most commonly used in reference to scalars vs collections in PowerShell. E.g.,

"When the left-hand side operand is a scalar value, -eq returns a boolean value. When the operand is a collection, -eq acts as a filter and returns matching items from the collection.

I think this section should specifically draw the comparison between scalar vs collection.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, that is not really accurate. It should be singleton instead of scalar.

sdwheeler and others added 2 commits January 6, 2026 09:03
Co-authored-by: surfingoldelephant <151538956+surfingoldelephant@users.noreply.github.com>
Co-authored-by: surfingoldelephant <151538956+surfingoldelephant@users.noreply.github.com>
@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

1 similar comment
@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 35cdc75:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 9eaac16:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

Co-authored-by: surfingoldelephant <151538956+surfingoldelephant@users.noreply.github.com>
@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 49495f5:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 3ebe06b:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 1deca1b:

✅ Validation status: passed

File Status Preview URL Details
terminology.md ✅Succeeded

For more details, please refer to the build report.

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