Merge pull request #3080 from microsoftgraph/tm/fix-example-description

timayabi2020 · web-flow · commit c52523938f99 · 2025-01-21T10:32:37.000+03:00
Removes unnecessary '#' characters in example descriptions
diff --git a/src/Applications/beta/examples/Get-MgBetaApplicationDelta.md b/src/Applications/beta/examples/Get-MgBetaApplicationDelta.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Beta.Applications
 Get-MgBetaApplicationDelta
 
 ```
-This example will### example
+This example shows how to use the Get-MgBetaApplicationDelta Cmdlet.
 
diff --git a/src/Applications/beta/examples/Get-MgBetaServicePrincipalSynchronizationTemplate.md b/src/Applications/beta/examples/Get-MgBetaServicePrincipalSynchronizationTemplate.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Beta.Applications
 Get-MgBetaServicePrincipalSynchronizationTemplate -ServicePrincipalId $servicePrincipalId
 
 ```
-This example will### example
+This example shows how to use the Get-MgBetaServicePrincipalSynchronizationTemplate Cmdlet.
 
diff --git a/src/Applications/v1.0/examples/Get-MgServicePrincipalSynchronizationTemplate.md b/src/Applications/v1.0/examples/Get-MgServicePrincipalSynchronizationTemplate.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Applications
 Get-MgServicePrincipalSynchronizationTemplate -ServicePrincipalId $servicePrincipalId
 
 ```
-This example will### example
+This example shows how to use the Get-MgServicePrincipalSynchronizationTemplate Cmdlet.
 
diff --git a/src/Bookings/beta/examples/Initialize-MgBetaBackupRestoreProtectionPolicy.md b/src/Bookings/beta/examples/Initialize-MgBetaBackupRestoreProtectionPolicy.md
@@ -7,7 +7,7 @@ Import-Module Microsoft.Graph.Beta.Bookings
 Initialize-MgBetaBackupRestoreProtectionPolicy -ProtectionPolicyBaseId $protectionPolicyBaseId
 
 ```
-This example will### example 1 : activate an inactive protection policy
+This example will activate an inactive protection policy
 
 ### Example 2 : Activate an active protection policy
 
@@ -18,5 +18,5 @@ Import-Module Microsoft.Graph.Beta.Bookings
 Initialize-MgBetaBackupRestoreProtectionPolicy -ProtectionPolicyBaseId $protectionPolicyBaseId
 
 ```
-This example will### example 2 : activate an active protection policy
+This example will activate an active protection policy
 
diff --git a/src/Bookings/beta/examples/Invoke-MgBetaDeactivateSolutionBackupRestoreProtectionPolicy.md b/src/Bookings/beta/examples/Invoke-MgBetaDeactivateSolutionBackupRestoreProtectionPolicy.md
@@ -18,5 +18,5 @@ Import-Module Microsoft.Graph.Beta.Bookings
 Invoke-MgBetaDeactivateSolutionBackupRestoreProtectionPolicy -ProtectionPolicyBaseId $protectionPolicyBaseId
 
 ```
-This example will### example 2 : deactivate a protection policy in updating state
+This example will deactivate a protection policy in updating state
 
diff --git a/src/Bookings/v1.0/examples/Invoke-MgDeactivateSolutionBackupRestoreProtectionPolicy.md b/src/Bookings/v1.0/examples/Invoke-MgDeactivateSolutionBackupRestoreProtectionPolicy.md
@@ -18,5 +18,5 @@ Import-Module Microsoft.Graph.Bookings
 Invoke-MgDeactivateSolutionBackupRestoreProtectionPolicy -ProtectionPolicyBaseId $protectionPolicyBaseId
 
 ```
-This example will### example 2 : deactivate a protection policy in updating state
+This example will deactivate a protection policy in updating state
 
diff --git a/src/CloudCommunications/beta/examples/New-MgBetaCommunicationCall.md b/src/CloudCommunications/beta/examples/New-MgBetaCommunicationCall.md
@@ -448,7 +448,7 @@ $params = @{
 New-MgBetaCommunicationCall -BodyParameter $params
 
 ```
-This example will### example 10: join channel meeting as a guest with service hosted media
+This example will join channel meeting as a guest with service hosted media
 
 ### Example 11: Create peer-to-peer PSTN call with service hosted media
 
@@ -498,7 +498,7 @@ $params = @{
 New-MgBetaCommunicationCall -BodyParameter $params
 
 ```
-This example will### example 11: create peer-to-peer pstn call with service hosted media
+This example will create peer-to-peer pstn call with service hosted media
 
 ### Example 12: Create peer-to-peer PSTN call with application hosted media
 
@@ -549,5 +549,5 @@ $params = @{
 New-MgBetaCommunicationCall -BodyParameter $params
 
 ```
-This example will### example 12: create peer-to-peer pstn call with application hosted media
+This example will create peer-to-peer pstn call with application hosted media
 
diff --git a/src/CloudCommunications/v1.0/examples/New-MgCommunicationCall.md b/src/CloudCommunications/v1.0/examples/New-MgCommunicationCall.md
@@ -450,5 +450,5 @@ $params = @{
 New-MgCommunicationCall -BodyParameter $params
 
 ```
-This example will### example 10: create peer-to-peer pstn call with application hosted media
+This example will create peer-to-peer pstn call with application hosted media
 
diff --git a/src/Identity.DirectoryManagement/beta/examples/Get-MgBetaDirectoryRoleDelta.md b/src/Identity.DirectoryManagement/beta/examples/Get-MgBetaDirectoryRoleDelta.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
 Get-MgBetaDirectoryRoleDelta
 
 ```
-This example will### example
+This example shows how to use the Get-MgBetaDirectoryRoleDelta Cmdlet.
 
diff --git a/src/Identity.DirectoryManagement/v1.0/examples/Get-MgDirectoryRoleDelta.md b/src/Identity.DirectoryManagement/v1.0/examples/Get-MgDirectoryRoleDelta.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Identity.DirectoryManagement
 Get-MgDirectoryRoleDelta
 
 ```
-This example will### example
+This example shows how to use the Get-MgDirectoryRoleDelta Cmdlet.
 
diff --git a/src/Identity.Governance/beta/examples/Get-MgBetaEntitlementManagementAccessPackageAssignment.md b/src/Identity.Governance/beta/examples/Get-MgBetaEntitlementManagementAccessPackageAssignment.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Beta.Identity.Governance
 Get-MgBetaEntitlementManagementAccessPackageAssignment
 
 ```
-This example will### example scenarios for using query parameters
+This example shows scenarios for using query parameters
 
diff --git a/src/Identity.Governance/beta/examples/Get-MgBetaEntitlementManagementAssignmentRequest.md b/src/Identity.Governance/beta/examples/Get-MgBetaEntitlementManagementAssignmentRequest.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Beta.Identity.Governance
 Get-MgBetaEntitlementManagementAssignmentRequest
 
 ```
-This example will### example scenarios for using query parameters
+This example shows scenarios for using query parameters
 
diff --git a/src/Identity.Governance/beta/examples/Get-MgBetaRoleManagementDirectoryRoleAssignment.md b/src/Identity.Governance/beta/examples/Get-MgBetaRoleManagementDirectoryRoleAssignment.md
@@ -7,7 +7,7 @@ Import-Module Microsoft.Graph.Beta.Identity.Governance
 Get-MgBetaRoleManagementDirectoryRoleAssignment -UnifiedRoleAssignmentId $unifiedRoleAssignmentId
 
 ```
-This example will### Example 1: get details of a role assignment
+This example will get details of a role assignment
 
 ### Example 2: Get details of a role assignment and expand the role definition
 
diff --git a/src/Identity.Governance/beta/examples/Get-MgBetaRoleManagementDirectoryTransitiveRoleAssignment.md b/src/Identity.Governance/beta/examples/Get-MgBetaRoleManagementDirectoryTransitiveRoleAssignment.md
@@ -8,7 +8,7 @@ Get-MgBetaRoleManagementDirectoryTransitiveRoleAssignment -CountVariable CountVa
 
 
 ```
-This example will### example 1 : get direct and transitive role assignments of a principal
+This example will get direct and transitive role assignments of a principal
 
 ### Example 2: Get direct and transitive assignments of a principal, but only specific role definitions
 
diff --git a/src/Identity.Governance/beta/examples/New-MgBetaRoleManagementDirectoryRoleAssignment.md b/src/Identity.Governance/beta/examples/New-MgBetaRoleManagementDirectoryRoleAssignment.md
@@ -32,7 +32,7 @@ $params = @{
 New-MgBetaRoleManagementDirectoryRoleAssignment -BodyParameter $params
 
 ```
-This example will### Example 2: create a role assignment with administrative unit scope
+This example will create a role assignment with administrative unit scope
 
 ### Example 3: Create a role assignment with attribute set scope
 
@@ -50,5 +50,5 @@ $params = @{
 New-MgBetaRoleManagementDirectoryRoleAssignment -BodyParameter $params
 
 ```
-This example will### Example 3: create a role assignment with attribute set scope
+This example will create a role assignment with attribute set scope
 
diff --git a/src/Identity.Governance/v1.0/examples/Get-MgEntitlementManagementAssignment.md b/src/Identity.Governance/v1.0/examples/Get-MgEntitlementManagementAssignment.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Identity.Governance
 Get-MgEntitlementManagementAssignment
 
 ```
-This example will### example scenarios for using query parameters
+This example shows scenarios for using query parameters
 
diff --git a/src/Identity.Governance/v1.0/examples/Get-MgEntitlementManagementAssignmentRequest.md b/src/Identity.Governance/v1.0/examples/Get-MgEntitlementManagementAssignmentRequest.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Identity.Governance
 Get-MgEntitlementManagementAssignmentRequest
 
 ```
-This example will### example scenarios for using query parameters
+This example shows scenarios for using query parameters
 
diff --git a/src/Identity.Governance/v1.0/examples/Get-MgRoleManagementDirectoryRoleAssignment.md b/src/Identity.Governance/v1.0/examples/Get-MgRoleManagementDirectoryRoleAssignment.md
@@ -7,7 +7,7 @@ Import-Module Microsoft.Graph.Identity.Governance
 Get-MgRoleManagementDirectoryRoleAssignment -UnifiedRoleAssignmentId $unifiedRoleAssignmentId
 
 ```
-This example will### example 1 : get the details of a role assignment
+This example will get the details of a role assignment
 
 ### Example 2: Get the details of a role assignment and expand the relationships
 
diff --git a/src/Identity.Governance/v1.0/examples/New-MgRoleManagementDirectoryRoleAssignment.md b/src/Identity.Governance/v1.0/examples/New-MgRoleManagementDirectoryRoleAssignment.md
@@ -32,7 +32,7 @@ $params = @{
 New-MgRoleManagementDirectoryRoleAssignment -BodyParameter $params
 
 ```
-This example will### Example 2: create a role assignment with administrative unit scope
+This example will create a role assignment with administrative unit scope
 
 ### Example 3: Create a role assignment with application scope
 
@@ -50,5 +50,5 @@ $params = @{
 New-MgRoleManagementDirectoryRoleAssignment -BodyParameter $params
 
 ```
-This example will### Example 3: create a role assignment with application scope
+This example will create a role assignment with application scope
 
diff --git a/src/Identity.SignIns/beta/examples/Get-MgBetaServicePrincipalRiskDetection.md b/src/Identity.SignIns/beta/examples/Get-MgBetaServicePrincipalRiskDetection.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Beta.Identity.SignIns
 Get-MgBetaServicePrincipalRiskDetection -ServicePrincipalRiskDetectionId $servicePrincipalRiskDetectionId
 
 ```
-This example will### example: get a specific risk detection object
+This example will get a specific risk detection object
 
diff --git a/src/Identity.SignIns/v1.0/examples/Get-MgServicePrincipalRiskDetection.md b/src/Identity.SignIns/v1.0/examples/Get-MgServicePrincipalRiskDetection.md
@@ -7,5 +7,5 @@ Import-Module Microsoft.Graph.Identity.SignIns
 Get-MgServicePrincipalRiskDetection -ServicePrincipalRiskDetectionId $servicePrincipalRiskDetectionId
 
 ```
-This example will### example: get a specific risk detection object
+This example will get a specific risk detection object
 
diff --git a/src/Search/beta/examples/Set-MgBetaExternalConnectionItem.md b/src/Search/beta/examples/Set-MgBetaExternalConnectionItem.md
@@ -33,5 +33,5 @@ $params = @{
 Set-MgBetaExternalConnectionItem -ExternalConnectionId $externalConnectionId -ExternalItemId $externalItemId -BodyParameter $params
 
 ```
-This example will### example: create a custom item
+This example will create a custom item
 
diff --git a/src/Search/v1.0/examples/Set-MgExternalConnectionItem.md b/src/Search/v1.0/examples/Set-MgExternalConnectionItem.md
@@ -31,5 +31,5 @@ $params = @{
 Set-MgExternalConnectionItem -ExternalConnectionId $externalConnectionId -ExternalItemId $externalItemId -BodyParameter $params
 
 ```
-This example will### example: create a custom item
+This example will create a custom item
 
diff --git a/src/Teams/beta/examples/New-MgBetaChatMessage.md b/src/Teams/beta/examples/New-MgBetaChatMessage.md
@@ -46,5 +46,5 @@ $params = @{
 New-MgBetaChatMessage -ChatId $chatId -BodyParameter $params
 
 ```
-This example will### Example 2: send a message with an emoji
+This example will send a message with an emoji
 
diff --git a/src/Teams/beta/examples/New-MgBetaTeamChannelMessage.md b/src/Teams/beta/examples/New-MgBetaTeamChannelMessage.md
@@ -263,7 +263,7 @@ $params = @{
 New-MgBetaTeamChannelMessage -TeamId $teamId -ChannelId $channelId -BodyParameter $params
 
 ```
-This example will### Example 6: @mention a channel in a channel message
+This example will @mention a channel in a channel message
 
 ### Example 7: @mention a team in a channel message
 
@@ -328,7 +328,7 @@ $params = @{
 New-MgBetaTeamChannelMessage -TeamId $teamId -ChannelId $channelId -BodyParameter $params
 
 ```
-This example will### Example 8: @mention a tag in a channel message
+This example will @mention a tag in a channel message
 
 ### Example 9: Send message that contains cards that are attributed to a Teams app
 
@@ -371,7 +371,7 @@ $params = @{
 New-MgBetaTeamChannelMessage -TeamId $teamId -ChannelId $channelId -BodyParameter $params
 
 ```
-This example will### Example 9: send message that contains cards that are attributed to a teams app
+This example will send message that contains cards that are attributed to a teams app
 
 ### Example 10: Send a message that contains an announcement
 
@@ -412,5 +412,5 @@ $params = @{
 New-MgBetaTeamChannelMessage -TeamId $teamId -ChannelId $channelId -BodyParameter $params
 
 ```
-This example will### Example 10: send a message that contains an announcement
+This example will send a message that contains an announcement
 
diff --git a/src/Teams/v1.0/examples/Get-MgChatInstalledApp.md b/src/Teams/v1.0/examples/Get-MgChatInstalledApp.md
@@ -7,7 +7,7 @@ Import-Module Microsoft.Graph.Teams
 Get-MgChatInstalledApp -ChatId $chatId -TeamsAppInstallationId $teamsAppInstallationId
 
 ```
-This example will### example 1 : get the app installed in the specified chat
+This example will get the app installed in the specified chat
 
 ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat
 
diff --git a/src/Teams/v1.0/examples/New-MgChatMessage.md b/src/Teams/v1.0/examples/New-MgChatMessage.md
@@ -46,5 +46,5 @@ $params = @{
 New-MgChatMessage -ChatId $chatId -BodyParameter $params
 
 ```
-This example will### Example 2: send a message with an emoji
+This example will send a message with an emoji
 
diff --git a/src/Teams/v1.0/examples/New-MgTeamChannelMessage.md b/src/Teams/v1.0/examples/New-MgTeamChannelMessage.md
@@ -366,7 +366,7 @@ $params = @{
 New-MgTeamChannelMessage -TeamId $teamId -ChannelId $channelId -BodyParameter $params
 
 ```
-This example will### Example 9: send message that contains cards that are attributed to a teams app
+This example will send message that contains cards that are attributed to a teams app
 
 ### Example 10: Send a message that contains an announcement
 
@@ -407,5 +407,5 @@ $params = @{
 New-MgTeamChannelMessage -TeamId $teamId -ChannelId $channelId -BodyParameter $params
 
 ```
-This example will### Example 10: send a message that contains an announcement
+This example will send a message that contains an announcement
 
diff --git a/tools/ImportExamples.ps1 b/tools/ImportExamples.ps1
@@ -313,8 +313,17 @@ function Update-ExampleFile {
                     elseif ($FirstDescriptionString.EndsWith("ing")) {
                         $DescriptionPrefix = "This example shows"
                     }
-                   
-                    $Description = $DescriptionPrefix + $TitleDesc.ToLower()
+                    elseif ($FirstDescriptionString.EndsWith("Example")) {
+                        $DescriptionPrefix = "This example shows how to use"
+                    }
+                    
+                    $Description = ""
+                    if ($FirstDescriptionString -eq "Example") {
+                        $Description = "This example shows how to use the $CommandPattern Cmdlet."
+                    }
+                    else {
+                        $Description = $DescriptionPrefix + $TitleDesc.ToLower()
+                    }
                 }
                 $TotalText = "$TitleValue`r`n`n$CodeValue`r`n$Description`r`n"
                 Add-Content -Path $ExampleFile -Value $TotalText
@@ -340,6 +349,7 @@ function Update-ExampleFile {
                 $ContainsPatternToSearch = $True
             }
         }
+        Write-Host $ContainsPatternToSearch
         if ($ContainsPatternToSearch) {
             Clear-Content $ExampleFile -Force    
             for ($d = 0; $d -lt $HeaderList.Count; $d++) { 
@@ -360,8 +370,17 @@ function Update-ExampleFile {
                         elseif ($FirstDescriptionString.EndsWith("ing")) {
                             $DescriptionPrefix = "This example shows"
                         }
-                       
-                        $Description = $DescriptionPrefix + $TitleDesc.ToLower()
+                        elseif ($FirstDescriptionString.EndsWith("Example")) {
+                            $DescriptionPrefix = "This example shows how to use"
+                        }
+                        
+                        $Description = ""
+                        if ($FirstDescriptionString -eq "Example") {
+                            $Description = "This example shows how to use the $CommandPattern Cmdlet."
+                        }
+                        else {
+                            $Description = $DescriptionPrefix + $TitleDesc.ToLower()
+                        }
                     }      
                     $TotalText = "$TitleValue`r`n`n$CodeValue`r`n$Description`r`n"
                     Add-Content -Path $ExampleFile -Value $TotalText
@@ -573,4 +592,4 @@ Start-Generator -ModulesToGenerate $ModulesToGenerate -GenerationMode "auto"
 
 #4. Test for beta updates from api reference
 #Start-Generator -GenerationMode "manual" -ManualExternalDocsUrl "https://docs.microsoft.com/graph/api/serviceprincipal-post-approleassignedto?view=graph-rest-beta" -GraphCommand "New-MgBetaServicePrincipalAppRoleAssignedTo" -GraphModule "Applications" -Profile "beta"
-#Start-Generator -GenerationMode "manual" -ManualExternalDocsUrl "https://learn.microsoft.com/en-us/graph/api/subscription-reauthorize?view=graph-rest-1.0&tabs=powershell" -GraphCommand "Invoke-MgReauthorizeSubscription" -GraphModule "ChangeNotifications" -Profile "v1.0"
+#Start-Generator -GenerationMode "manual" -ManualExternalDocsUrl "https://learn.microsoft.com/en-us/graph/api/synchronization-synchronization-list-templates?view=graph-rest-beta&tabs=powershell" -GraphCommand "Get-MgBetaServicePrincipalSynchronizationTemplate" -GraphModule "Applications" -Profile "beta"
