Skip to content

Fix incorrect examples in XML docs in PowerShell.cs #21173

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.

Sign up for GitHub

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

Merged
daxian-dbw merged 13 commits into from
Feb 1, 2024
+22 −16
Merged

Fix incorrect examples in XML docs in PowerShell.cs #21173

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
95e12f4
Update code examples in XML docs in PowerShell.cs
daxian-dbw Feb 1, 2024
7bc381c
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
9d4a512
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
68a1ba1
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
ec9fa89
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
e8120a6
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
cea5e96
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
3b01a97
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
8e089df
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
69b826e
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
17d6eac
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
c872314
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
2c8611e
Update src/System.Management.Automation/engine/hostifaces/PowerShell.cs
daxian-dbw Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions src/System.Management.Automation/engine/hostifaces/PowerShell.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -946,9 +946,11 @@ private static PowerShell Create(bool isNested, PSCommand psCommand, Collection<

/// <summary>
/// Add a cmdlet to construct a command pipeline.
/// For example, to construct a command string "get-process | sort-object",
/// For example, to construct a command string "Get-Process | Sort-Object",
/// <code>
/// PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");
/// PowerShell shell = PowerShell.Create()
/// .AddCommand("Get-Process")
/// .AddCommand("Sort-Object");
/// </code>
/// </summary>
/// <param name="cmdlet">
Expand Down Expand Up @@ -984,9 +986,11 @@ public PowerShell AddCommand(string cmdlet)

/// <summary>
/// Add a cmdlet to construct a command pipeline.
/// For example, to construct a command string "get-process | sort-object",
/// For example, to construct a command string "Get-Process | Sort-Object",
/// <code>
/// PowerShell shell = PowerShell.Create("get-process").AddCommand("sort-object");
/// PowerShell shell = PowerShell.Create()
/// .AddCommand("Get-Process", true)
/// .AddCommand("Sort-Object", true);
/// </code>
/// </summary>
/// <param name="cmdlet">
Expand Down Expand Up @@ -1025,10 +1029,10 @@ public PowerShell AddCommand(string cmdlet, bool useLocalScope)

/// <summary>
/// Add a piece of script to construct a command pipeline.
/// For example, to construct a command string "get-process | foreach { $_.Name }"
/// For example, to construct a command string "Get-Process | ForEach-Object { $_.Name }"
/// <code>
/// PowerShell shell = PowerShell.Create("get-process").
/// AddCommand("foreach { $_.Name }", true);
/// PowerShell shell = PowerShell.Create()
/// .AddScript("Get-Process | ForEach-Object { $_.Name }");
/// </code>
/// </summary>
/// <param name="script">
Expand Down Expand Up @@ -1064,10 +1068,10 @@ public PowerShell AddScript(string script)

/// <summary>
/// Add a piece of script to construct a command pipeline.
/// For example, to construct a command string "get-process | foreach { $_.Name }"
/// For example, to construct a command string "Get-Process | ForEach-Object { $_.Name }"
/// <code>
/// PowerShell shell = PowerShell.Create("get-process").
/// AddCommand("foreach { $_.Name }", true);
/// PowerShell shell = PowerShell.Create()
/// .AddScript("Get-Process | ForEach-Object { $_.Name }", true);
/// </code>
/// </summary>
/// <param name="script">
Expand Down Expand Up @@ -1173,10 +1177,11 @@ public PowerShell AddCommand(CommandInfo commandInfo)

/// <summary>
/// Add a parameter to the last added command.
/// For example, to construct a command string "get-process | select-object -property name"
/// For example, to construct a command string "Get-Process | Select-Object -Property Name"
/// <code>
/// PowerShell shell = PowerShell.Create("get-process").
/// AddCommand("select-object").AddParameter("property","name");
/// PowerShell shell = PowerShell.Create()
/// .AddCommand("Get-Process")
/// .AddCommand("Select-Object").AddParameter("Property", "Name");
/// </code>
/// </summary>
/// <param name="parameterName">
Expand Down Expand Up @@ -1378,10 +1383,11 @@ public PowerShell AddParameters(IDictionary parameters)

/// <summary>
/// Adds an argument to the last added command.
/// For example, to construct a command string "get-process | select-object name"
/// For example, to construct a command string "Get-Process | Select-Object Name"
/// <code>
/// PowerShell shell = PowerShell.Create("get-process").
/// AddCommand("select-object").AddParameter("name");
/// PowerShell shell = PowerShell.Create()
/// .AddCommand("Get-Process")
/// .AddCommand("Select-Object").AddArgument("Name");
/// </code>
/// This will add the value "name" to the positional parameter list of "select-object"
/// cmdlet. When the command is invoked, this value will get bound to positional parameter 0
Expand Down