Skip to content

Commit 2dfecc0

Browse files
authored
Updated Az Predictor cmdlet help (#14331)
* Updated Az Predictor cmdlet help * Added synopsis for Az Predictor * fixed typo in Disable-AzPredictor cmdlet
1 parent 8d1dcea commit 2dfecc0

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/DisableAzPredictor.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
1919
{
2020
/// <summary>
21-
/// A cmdlet that disable Az Predictor.
21+
/// <para type="synopsis"> Cmdlet to disable Az Predictor and stop recieving suggestions</para>
22+
/// <para type="description"> Use this cmdlet to disable Az Predictor and stop recieving suggestions</para>
2223
/// </summary>
2324
[Cmdlet("Disable", "AzPredictor")]
2425
public sealed class DisableAzPredictor : PSCmdlet
@@ -28,13 +29,13 @@ public sealed class DisableAzPredictor : PSCmdlet
2829
};
2930

3031
/// <summary>
31-
/// Indicates whether it's applied to all sessions.
32+
/// <para type="description"> Disable Az Predictor for the curent and future PowerShell sessions.</para>
3233
/// </summary>
3334
[Parameter(Mandatory = false)]
3435
public SwitchParameter AllSession { get; set; }
3536

3637
/// <summary>
37-
/// Indicates whether the user would like to receive output.
38+
/// <para type="description"> Indicates whether the user would like to receive output. </para>
3839
/// </summary>
3940
[Parameter(Mandatory = false)]
4041
public SwitchParameter PassThru { get; set; }

tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/EnableAzPredictor.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
1919
{
2020
/// <summary>
21-
/// A cmdlet that enables Az Predictor with default settings.
21+
/// <para type="synopsis"> Cmdlet to enable Az Predictor and start recieving suggestions</para>
22+
/// <para type="description"> Use this cmdlet to enable Az Predictor and start recieving suggestions</para>
2223
/// </summary>
2324
[Cmdlet("Enable", "AzPredictor"), OutputType(typeof(bool))]
2425
public sealed class EnableAzPredictor : PSCmdlet
@@ -29,13 +30,13 @@ public sealed class EnableAzPredictor : PSCmdlet
2930
};
3031

3132
/// <summary>
32-
/// Indicates whether it's applied to all sessions.
33+
/// <para type="description"> Enable Az Predictor for the current and futrue PowerShell sessions.</para>
3334
/// </summary>
3435
[Parameter(Mandatory = false)]
3536
public SwitchParameter AllSession { get; set; }
3637

3738
/// <summary>
38-
/// Indicates whether the user would like to receive output.
39+
/// <para type="description"> Indicates whether the user would like to receive output. </para>
3940
/// </summary>
4041
[Parameter(Mandatory = false)]
4142
public SwitchParameter PassThru { get; set; }

0 commit comments

Comments
 (0)