admin/PowerShell-PowerShell
1
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell synced 2026-06-08 12:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix formatting of the XML comment for SteppablePipeline.Clean() (#24941)

Browse Source
This commit is contained in:
Sean Wheeler
2025-02-04 09:37:22 -08:00
committed by GitHub
parent 141da816ab
commit f84c777b72
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/System.Management.Automation/engine/lang/scriptblock.cs
+7 -5
View File
@@ -1276,14 +1276,16 @@ namespace System.Management.Automation
/// Clean resources for script commands of this steppable pipeline.
/// </summary>
/// <remarks>
/// The way we handle 'Clean' blocks in a steppable pipeline makes sure that:
/// 1. The 'Clean' blocks get to run if any exception is thrown from 'Begin/Process/End'.
/// 2. The 'Clean' blocks get to run if 'End' finished successfully.
/// <para>
/// The way we handle 'Clean' blocks in a steppable pipeline makes sure that:</para>
/// <para>1. The 'Clean' blocks get to run if any exception is thrown from 'Begin/Process/End'.</para>
/// <para>2. The 'Clean' blocks get to run if 'End' finished successfully.</para>
/// <para>
/// However, this is not enough for a steppable pipeline, because the function, where the steppable
/// pipeline gets used, may fail (think about a proxy function). And that may lead to the situation
/// where "no exception was thrown from the steppable pipeline" but "the steppable pipeline didn't
/// run to the end". In that case, 'Clean' won't run unless it's triggered explicitly on the steppable
/// pipeline. This method allows a user to do that from the 'Clean' block of the proxy function.
/// pipeline. This method allows a user to do that from the 'Clean' block of the proxy function.</para>
/// </remarks>
public void Clean()
{
@@ -1386,7 +1388,7 @@ namespace System.Management.Automation
/// </summary>
/// <param name="info">Serialization information.</param>
/// <param name="context">Streaming context.</param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected ScriptBlockToPowerShellNotSupportedException(SerializationInfo info, StreamingContext context)
{
throw new NotSupportedException();