SqlServerDsc.Common: Fix comment-based help and remove debug code (#1549

)

CHANGELOG.md

@@ -42,7 +42,8 @@ in a future release.
   - Fixing a problem with the latest ModuleBuild 1.7.0 that breaks the CI
     pipeline.
 - SqlServerDsc.Common
-  - Added function `Import-Assembly`.
+  - Added function `Import-Assembly` that can help import an assembly
+    into the PowerShell session.
   - Prepared unit tests to support Pester 5 so a minimal conversation
     is only needed later.
   - Updated `Import-SQLPSModule` to better support unit tests.

source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1

@@ -672,10 +672,11 @@ function Connect-SQLAnalysis
 
 <#
     .SYNOPSIS
-        Returns a reference to the ConnectionInfo assembly.
+        Imports the assembly into the session.
 
     .DESCRIPTION
-        Returns a reference to the ConnectionInfo assembly.
+        Imports the assembly into the session and returns a reference to the
+        assembly.
 
     .PARAMETER Name
         Specifies the name of the assembly to load.
@@ -724,12 +725,10 @@ function Import-Assembly
     {
         if ($LoadWithPartialName.IsPresent)
         {
-            Write-Verbose -Message 'DEBUG1' -Verbose
             $assemblyInformation = [System.Reflection.Assembly]::LoadWithPartialName($Name)
         }
         else
         {
-            Write-Verbose -Message 'DEBUG2' -Verbose
             $assemblyInformation = [System.Reflection.Assembly]::Load($Name)
         }
 
@@ -739,7 +738,6 @@ function Import-Assembly
     }
     catch
     {
-        Write-Verbose ($_ | Out-String) -Verbose
         $errorMessage = $script:localizedData.FailedToLoadAssembly -f $Name
 
         New-InvalidOperationException -Message $errorMessage -ErrorRecord $_