Skip to content

Updated Az Predictor cmdlet help #14331

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
merged 3 commits into from
Feb 26, 2021
Merged

Updated Az Predictor cmdlet help #14331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
003bf08
Updated Az Predictor cmdlet help
dcaro Feb 25, 2021
ddaf2b9
Added synopsis for Az Predictor
dcaro Feb 25, 2021
87be857
fixed typo in Disable-AzPredictor cmdlet
dcaro Feb 25, 2021
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
7 changes: 4 additions & 3 deletions tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/DisableAzPredictor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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; }
Expand Down
7 changes: 4 additions & 3 deletions tools/Az.Tools.Predictor/Az.Tools.Predictor/Commands/EnableAzPredictor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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; }
Expand Down