Jelajahi Sumber

style-guide, pages/windows/*: add note for PowerShell descriptions (#12904)

*: add note for pwsh descriptions

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
K.B.Dharun Krishna 9 bulan lalu
induk
melakukan
a8ec294384

+ 1 - 1
contributing-guides/style-guide.md

@@ -103,7 +103,7 @@ Thus, if the command or its options are unavailable or contain different behavio
 # Clear-RecycleBin
 
 > Clear items from the Recycle Bin.
-> This command can only be used through PowerShell versions 5.1 and below, or 7.1 and above.
+> Note: This command can only be used through PowerShell versions 5.1 and below, or 7.1 and above.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/clear-recyclebin>.
 ```
 

+ 1 - 1
pages/windows/clear-host.md

@@ -1,7 +1,7 @@
 # Clear-Host
 
 > Clears the screen.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.core/clear-host>.
 
 - Clear the screen:

+ 1 - 1
pages/windows/get-acl.md

@@ -1,7 +1,7 @@
 # Get-Acl
 
 > Get the security descriptor for a resource, such as a file or registry key.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-acl>.
 
 - Display the ACL for a specific directory:

+ 1 - 1
pages/windows/get-childitem.md

@@ -1,7 +1,7 @@
 # Get-ChildItem
 
 > List items in a directory.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-childitem>.
 
 - List all non-hidden items in the current directory:

+ 1 - 1
pages/windows/get-content.md

@@ -1,7 +1,7 @@
 # Get-Content
 
 > Get the content of the item at the specified location.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-content>.
 
 - Display the content of a file:

+ 1 - 1
pages/windows/get-date.md

@@ -1,7 +1,7 @@
 # Get-Date
 
 > Get the current date and time.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/get-date>.
 
 - Display the current date and time:

+ 1 - 1
pages/windows/get-filehash.md

@@ -1,7 +1,7 @@
 # Get-FileHash
 
 > Calculate a hash for a file.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/get-filehash>.
 
 - Calculate a hash for a specified file using the SHA256 algorithm:

+ 1 - 1
pages/windows/get-history.md

@@ -1,7 +1,7 @@
 # Get-History
 
 > Display PowerShell command history.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-history>.
 
 - Display the commands history list with ID:

+ 1 - 1
pages/windows/invoke-item.md

@@ -1,7 +1,7 @@
 # Invoke-Item
 
 > Open files in their respective default programs.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/invoke-item>.
 
 - Open a file in its default program:

+ 1 - 1
pages/windows/invoke-webrequest.md

@@ -1,7 +1,7 @@
 # Invoke-WebRequest
 
 > Performs a HTTP/HTTPS request to the Web.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/invoke-webrequest>.
 
 - Download the contents of a URL to a file:

+ 1 - 1
pages/windows/measure-command.md

@@ -1,7 +1,7 @@
 # Measure-Command
 
 > Measures the time it takes to run script blocks and cmdlets.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/measure-command>.
 
 - Measure the time it takes to run a command:

+ 1 - 1
pages/windows/measure-object.md

@@ -1,7 +1,7 @@
 # Measure-Object
 
 > Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as files of text.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/measure-object>.
 
 - Count the files and folders in a directory:

+ 1 - 1
pages/windows/new-item.md

@@ -1,7 +1,7 @@
 # New-Item
 
 > Create a new file, directory, symbolic link, or a registry entry.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/new-item>.
 
 - Create a new blank file (equivalent to `touch`):

+ 1 - 1
pages/windows/out-string.md

@@ -1,7 +1,7 @@
 # Out-String
 
 > Outputs input objects as a string.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/out-string>.
 
 - Print host information as string:

+ 1 - 1
pages/windows/resolve-path.md

@@ -1,7 +1,7 @@
 # Resolve-Path
 
 > Resolves the wildcard characters in a path, and displays the path contents.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/resolve-path>.
 
 - Resolve the home folder path:

+ 1 - 1
pages/windows/select-string.md

@@ -1,7 +1,7 @@
 # Select-String
 
 > Finds text in strings and files in PowerShell.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > You can use `Select-String` similar to `grep` in UNIX or `findstr.exe` in Windows.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/select-string>.
 

+ 1 - 1
pages/windows/set-acl.md

@@ -1,7 +1,7 @@
 # Set-Acl
 
 > Changes the security descriptor of a specified item, such as a file or a registry key.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.security/set-acl>.
 
 - Copy a security descriptor from one file to another:

+ 1 - 1
pages/windows/set-date.md

@@ -1,7 +1,7 @@
 # Set-Date
 
 > Changes the system time on the computer to a time that you specify.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/set-date>.
 
 - Add three days to the system date:

+ 1 - 1
pages/windows/set-location.md

@@ -1,7 +1,7 @@
 # Set-Location
 
 > Display the current working directory or move to a different directory.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/set-location>.
 
 - Go to the specified directory:

+ 1 - 1
pages/windows/set-service.md

@@ -1,7 +1,7 @@
 # Set-Service
 
 > Starts, stops, and suspends a service, and changes its properties.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/set-service>.
 
 - Change a display name:

+ 1 - 1
pages/windows/show-markdown.md

@@ -1,7 +1,7 @@
 # Show-Markdown
 
 > Shows a Markdown file or string in the console in a friendly way using VT100 escape sequences or in a browser using HTML.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/show-markdown>.
 
 - Render markdown to console from a file:

+ 1 - 1
pages/windows/sort-object.md

@@ -1,7 +1,7 @@
 # Sort-Object
 
 > Sorts objects by property values.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/sort-object>.
 
 - Sort the current directory by name:

+ 1 - 1
pages/windows/start-service.md

@@ -1,7 +1,7 @@
 # Start-Service
 
 > Starts stopped services.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/start-service>.
 
 - Start a service by using its name:

+ 1 - 1
pages/windows/stop-service.md

@@ -1,7 +1,7 @@
 # Stop-Service
 
 > Stops running services.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/stop-service>.
 
 - Stop a service on the local computer:

+ 1 - 1
pages/windows/tee-object.md

@@ -1,7 +1,7 @@
 # Tee-Object
 
 > Saves command output in a file or variable and also sends it down the pipeline.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/tee-object>.
 
 - Output processes to a file and to the console:

+ 1 - 1
pages/windows/test-json.md

@@ -1,7 +1,7 @@
 # Test-Json
 
 > Test whether a string is a valid JSON document.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/test-json>.
 
 - Test if a string from `stdin` is in JSON format:

+ 1 - 1
pages/windows/test-netconnection.md

@@ -1,7 +1,7 @@
 # Test-NetConnection
 
 > Display diagnostic information for a connection.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/nettcpip/test-netconnection>.
 
 - Test a connection and display detailed results:

+ 1 - 1
pages/windows/wait-process.md

@@ -1,7 +1,7 @@
 # Wait-Process
 
 > Waits for the processes to be stopped before accepting more input.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.management/wait-process>.
 
 - Stop a process and wait:

+ 1 - 1
pages/windows/where-object.md

@@ -1,7 +1,7 @@
 # Where-Object
 
 > Selects objects from a collection based on their property values.
-> This command can only be used through PowerShell.
+> Note: This command can only be used through PowerShell.
 > More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.core/where-object>.
 
 - Filter aliases by its name: