Skip to content
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.

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

(GH-10780) Fix example in about_Intrinsic_Members #10784

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Jan 10, 2024

PR Summary

Prior to this change, about_Intrinsic_Members defines examples that describe a hashtable and interacts with a variable containing the hashtable but doesn't define the hashtable itself in the code blocks. The examples also use -Type with the Get-Member cmdlet, which is an alias for the paramter canonically named MemberType.

This change:

  • Defines the $hash variable in the first code block for the example, ensuring readers can follow along without needing to intuit the definition from the output.
  • Replaces usage of the -Type alias parameter with the canonical parameter name MemberType, making it easier for readers to look up the parameter. This also adheres to the docs style guide.
  • Resolves Missing information in the Example section of about_Intrinsic_Members #10780
  • Fixes AB#198703

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.

Prior to this change, `about_Intrinsic_Members` defines examples
that describe a hashtable and interacts with a variable containing
the hashtable but doesn't define the hashtable itself in the code
blocks. The examples also use `-Type` with the `Get-Member` cmdlet,
which is an alias for the paramter canonically named **MemberType**.

This change:

- Defines the `$hash` variable in the first code block for the
  example, ensuring readers can follow along without needing to
  intuit the definition from the output.
- Replaces usage of the `-Type` alias parameter with the canonical
  parameter name **MemberType**, making it easier for readers to
  look up the parameter. This also adheres to the docs style guide.
- Resolves MicrosoftDocs#10780
- Fixes AB#198703
Copy link
Contributor

Learn Build status updates of commit 3ab8bc0:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/docfx.json ⚠️Warning Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md ✅Succeeded View (powershell-7.4)

reference/docfx.json

  • Line 39, Column 41: [Warning: value-deprecated-replace - See documentation] The 'ms.prod: powershell, ms.technology: powershell-cmdlets' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: powershell, ms.subservice: cmdlets'.
  • Line 41, Column 41: [Warning: value-deprecated-replace - See documentation] The 'ms.prod: powershell, ms.technology: powershell-cmdlets' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: powershell, ms.subservice: cmdlets'.
  • Line 43, Column 41: [Warning: value-deprecated-replace - See documentation] The 'ms.prod: powershell, ms.technology: powershell-cmdlets' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: powershell, ms.subservice: cmdlets'.
  • Line 45, Column 41: [Warning: value-deprecated-replace - See documentation] The 'ms.prod: powershell, ms.technology: powershell-cmdlets' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: powershell, ms.subservice: cmdlets'.
  • Line 46, Column 58: [Warning: value-deprecated-replace - See documentation] The 'ms.prod: powershell, ms.technology: powershell-conceptual' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: powershell, ms.subservice: conceptual'.
  • Line 111, Column 29: [Warning: value-deprecated-replace - See documentation] The 'ms.prod: powershell' you used is now deprecated and can no longer be used. We suggest you replace it with 'ms.service: powershell'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@sdwheeler sdwheeler merged commit 21a0a34 into MicrosoftDocs:main Jan 10, 2024
5 checks passed
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.

Missing information in the Example section of about_Intrinsic_Members
2 participants