Add Snippet for Documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- powershell
- Domain
- tooling
Research direction
Start with the issue description and its linked Microsoft documentation example; no repository file, test, or entry point is identified. Review the existing PowerShell snippet conventions in the repository, then add the requested documentation snippet and verify that it matches the project's established format.
Written by the indexing model from the issue text.
Description
We should add a snippet for documentation. https://technet.microsoft.com/en-us/magazine/ff458353.aspx is the closest I found to a published standard.
Their example is:
<#
.SYNOPSIS
Retrieves service pack and operating system information from one or more remote computers.
.DESCRIPTION
The Get-Inventory function uses Windows Management Instrumentation (WMI) toretrieve service pack version, operating system build number, and BIOS serial number from one or more remote computers.
Computer names or IP addresses are expected as pipeline input, or may bepassed to the –computerName parameter.
Each computer is contacted sequentially, not in parallel.
.PARAMETER computerNameAccepts
a single computer name or an array of computer names. You mayalso provide IP addresses.
.PARAMETER path
The path and file name of a text file. Any computers that cannot be reached will be logged to this file.
This is an optional parameter; if it is notincluded, no log file will be generated.
.EXAMPLE
Read computer names from Active Directory and retrieve their inventory information.
Get-ADComputer –filter * | Select{Name="computerName";Expression={$_.Name}} | Get-Inventory.
.EXAMPLE
Read computer names from a file (one name per line) and retrieve their inventory information
Get-Content c:\names.txt | Get-Inventory.
.NOTES
You need to run this function as a member of the Domain Admins group; doing so is the only way to ensure you have permission to query WMI from the remote computers.
#>
- Dominant language
- PowerShell
- Stars
- 335
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SublimeText/PowerShell
-
tooling
Difficulty 4/5 3-5 days Newbie friendliness 42/100
SublimeText/PowerShell#226 ·
-
syntax
Difficulty 3/5 1-2 days Newbie friendliness 55/100
SublimeText/PowerShell#218 · 1 comment ·
-
syntax
Difficulty 3/5 1-2 days Newbie friendliness 48/100
SublimeText/PowerShell#211 ·
-
build system
Difficulty 3/5 1-2 days Newbie friendliness 45/100
SublimeText/PowerShell#170 · 8 comments ·
-
build system
Difficulty 4/5 3-5 days Newbie friendliness 25/100
SublimeText/PowerShell#167 · 2 comments ·
All issues in SublimeText/PowerShell
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ScoopInstaller/Nonportable#639 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ScoopInstaller/Extras#18800 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
uqbar-project/website-wollok-ts#84 · 2 comments ·
-
on hold T: core-bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100