Updated Az Predictor cmdlet help (#14331)

* Updated Az Predictor cmdlet help * Added synopsis for Az Predictor * fixed typo in Disable-AzPredictor cmdlet
Azure · Feb 26, 2021 · 2dfecc0 · 2dfecc0
1 parent 8d1dcea
commit 2dfecc0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/DisableAzPredictor.cs b/tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/DisableAzPredictor.cs
@@ -18,7 +18,8 @@
 namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
 {
     /// <summary>
-    /// A cmdlet that disable Az Predictor.
+    /// <para type="synopsis"> Cmdlet to disable Az Predictor and stop recieving suggestions</para>
+    /// <para type="description"> Use this cmdlet to disable Az Predictor and stop recieving suggestions</para>
     /// </summary>
     [Cmdlet("Disable", "AzPredictor")]
     public sealed class DisableAzPredictor : PSCmdlet
@@ -28,13 +29,13 @@ public sealed class DisableAzPredictor : PSCmdlet
         };
 
         /// <summary>
-        /// Indicates whether it's applied to all sessions.
+        /// <para type="description"> Disable Az Predictor for the curent and future PowerShell sessions.</para>
         /// </summary>
         [Parameter(Mandatory = false)]
         public SwitchParameter AllSession { get; set; }
 
         /// <summary>
-        /// Indicates whether the user would like to receive output.
+        /// <para type="description"> Indicates whether the user would like to receive output. </para>
         /// </summary>
         [Parameter(Mandatory = false)]
         public SwitchParameter PassThru { get; set; }

diff --git a/tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/EnableAzPredictor.cs b/tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/EnableAzPredictor.cs
@@ -18,7 +18,8 @@
 namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
 {
     /// <summary>
-    /// A cmdlet that enables Az Predictor with default settings.
+    /// <para type="synopsis"> Cmdlet to enable Az Predictor and start recieving suggestions</para>
+    /// <para type="description"> Use this cmdlet to enable Az Predictor and start recieving suggestions</para>
     /// </summary>
     [Cmdlet("Enable", "AzPredictor"), OutputType(typeof(bool))]
     public sealed class EnableAzPredictor : PSCmdlet
@@ -29,13 +30,13 @@ public sealed class EnableAzPredictor : PSCmdlet
         };
 
         /// <summary>
-        /// Indicates whether it's applied to all sessions.
+        /// <para type="description"> Enable Az Predictor for the current and futrue PowerShell sessions.</para>
         /// </summary>
         [Parameter(Mandatory = false)]
         public SwitchParameter AllSession { get; set; }
 
         /// <summary>
-        /// Indicates whether the user would like to receive output.
+        /// <para type="description"> Indicates whether the user would like to receive output. </para>
         /// </summary>
         [Parameter(Mandatory = false)]
         public SwitchParameter PassThru { get; set; }