Skip to content

Commit 6705540

Browse files
dingmeng-xuedingmeng-xue
authored
Update help for Az.Tools.Predictor (#14376)
* Update help for Az.Tools.Predictor (#14374) * update build.proj * Change help folder
1 parent 852b303 commit 6705540

File tree

6 files changed

+161
-13
lines changed

6 files changed

+161
-13
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
1919
{
2020
/// <summary>
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>
21+
/// <para type="synopsis">Cmdlet to disable Az Predictor and stop receiving suggestions</para>
22+
/// <para type="description">Use this cmdlet to disable Az Predictor and stop receiving suggestions</para>
2323
/// </summary>
2424
[Cmdlet("Disable", "AzPredictor")]
2525
public sealed class DisableAzPredictor : PSCmdlet
@@ -29,13 +29,13 @@ public sealed class DisableAzPredictor : PSCmdlet
2929
};
3030

3131
/// <summary>
32-
/// <para type="description"> Disable Az Predictor for the curent and future PowerShell sessions.</para>
32+
/// <para type="description">Disable Az Predictor for the current and future PowerShell sessions.</para>
3333
/// </summary>
3434
[Parameter(Mandatory = false)]
3535
public SwitchParameter AllSession { get; set; }
3636

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

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
1919
{
2020
/// <summary>
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>
21+
/// <para type="synopsis">Cmdlet to enable Az Predictor and start receiving suggestions</para>
22+
/// <para type="description">Use this cmdlet to enable Az Predictor and start receiving suggestions</para>
2323
/// </summary>
2424
[Cmdlet("Enable", "AzPredictor"), OutputType(typeof(bool))]
2525
public sealed class EnableAzPredictor : PSCmdlet
@@ -30,13 +30,13 @@ public sealed class EnableAzPredictor : PSCmdlet
3030
};
3131

3232
/// <summary>
33-
/// <para type="description"> Enable Az Predictor for the current and futrue PowerShell sessions.</para>
33+
/// <para type="description">Enable Az Predictor for the current and future PowerShell sessions.</para>
3434
/// </summary>
3535
[Parameter(Mandatory = false)]
3636
public SwitchParameter AllSession { get; set; }
3737

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

‎tools/Az.Tools.Predictor/GenerateHelp.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Param(
44
[Parameter()]
55
[string]$ArtifactFolder,
66
[Parameter()]
7+
[string]$HelpFolder,
8+
[Parameter()]
79
[string]$ModuleName
810
)
911

1012
$ModuleFolder = Join-Path -Path $ArtifactFolder -ChildPath $ModuleName
11-
$TempDocFolder = Join-Path -Path $ArtifactFolder -ChildPath $ModuleName'.Doc'
1213
Import-Module $ModuleFolder
13-
New-MarkdownHelp -Module $ModuleName -OutputFolder $TempDocFolder
14-
New-ExternalHelp –Path $TempDocFolder -OutputPath $ModuleFolder
14+
New-ExternalHelp –Path $HelpFolder -OutputPath $ModuleFolder -Force -Debug

‎tools/Az.Tools.Predictor/build.proj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
<Target Name="Clean">
2121
<Message Text="Clean artifacts folder" />
22-
<RemoveDir Directories="$(ArtifactFolder)/$(ModuleName)" />
22+
<RemoveDir Directories="$(ArtifactFolder)" />
2323
<RemoveDir Directories="$(TestOutputDirectory)" />
2424
</Target>
2525

@@ -35,7 +35,7 @@
3535
</Target>
3636

3737
<Target Name="GenerateHelp">
38-
<Exec Command="$(PowerShellCoreCommandPrefix) &quot;.\GenerateHelp -ArtifactFolder $(ArtifactFolder) -ModuleName $(ModuleName)" />
38+
<Exec Command="$(PowerShellCoreCommandPrefix) &quot;$(RepoTools)/$(ModuleName)/GenerateHelp.ps1 -ArtifactFolder $(ArtifactFolder) -HelpFolder $(RepoTools)/$(ModuleName)/help -ModuleName $(ModuleName)" />
3939
</Target>
4040

4141
<Target Name="Test" DependsOnTargets="Build">

‎tools/Az.Tools.Predictor/help/Disable-AzPredictor.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Tools.AzPredictor.dll-Help.xml
3+
Module Name: Az.Tools.Predictor
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Disable-AzPredictor
9+
10+
## SYNOPSIS
11+
Cmdlet to disable Az Predictor and stop receiving suggestions.
12+
13+
## SYNTAX
14+
15+
```
16+
Disable-AzPredictor [-AllSession] [-PassThru] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Use this cmdlet to disable Az Predictor and stop receiving suggestions.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```
26+
PS C:\> Disable-AzPredictor
27+
```
28+
29+
Disable Az Predictor only for the current session.
30+
31+
## PARAMETERS
32+
33+
### -AllSession
34+
Disable Az Predictor for the current and future PowerShell sessions.
35+
36+
```yaml
37+
Type: SwitchParameter
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: False
42+
Position: Named
43+
Default value: False
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -PassThru
49+
Indicates whether the user would like to receive output.
50+
51+
```yaml
52+
Type: SwitchParameter
53+
Parameter Sets: (All)
54+
Aliases:
55+
56+
Required: False
57+
Position: Named
58+
Default value: False
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
### None
69+
## OUTPUTS
70+
71+
### System.Object
72+
## NOTES
73+
74+
## RELATED LINKS

‎tools/Az.Tools.Predictor/help/Enable-AzPredictor.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Tools.AzPredictor.dll-Help.xml
3+
Module Name: Az.Tools.Predictor
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Enable-AzPredictor
9+
10+
## SYNOPSIS
11+
Cmdlet to enable Az Predictor and start receiving suggestions.
12+
13+
## SYNTAX
14+
15+
```
16+
Enable-AzPredictor [-AllSession] [-PassThru] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Use this cmdlet to enable Az Predictor and start receiving suggestions.
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```
26+
PS C:\> Enable-AzPredictor
27+
```
28+
29+
Enable Az Predictor for the current session.
30+
31+
## PARAMETERS
32+
33+
### -AllSession
34+
Enable Az Predictor for the current and future PowerShell sessions.
35+
36+
```yaml
37+
Type: SwitchParameter
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: False
42+
Position: Named
43+
Default value: False
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -PassThru
49+
Indicates whether the user would like to receive output.
50+
51+
```yaml
52+
Type: SwitchParameter
53+
Parameter Sets: (All)
54+
Aliases:
55+
56+
Required: False
57+
Position: Named
58+
Default value: False
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
### None
69+
## OUTPUTS
70+
71+
### System.Boolean
72+
## NOTES
73+
74+
## RELATED LINKS

0 commit comments

Comments
 (0)