Add blank lines to PowerShell script files

dsccommunity · Jan 14, 2024 · f25ccd3 · f25ccd3
1 parent 575f809
commit f25ccd3
Show file tree

Hide file tree

Showing 40 changed files with 44 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,6 +35,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Update markdown highlights with newly supported keywords.
   - Bump GitHub Action _Stale_ to v9.
   - Bump GitHub Action _CodeQL-Action_ to v3.
+  - Prefix every public command source script file with a blank line so
+    that PlatyPS can find the comment-based help. ModuleBuilder builds
+    the module without any white space between functions so PlayPS (or
+    `Get-Help`) cannot distinguish each individual commands comment-based
+    help.
 - SqlSetup
   - Updated integration tests to use PSResourceGet to download required modules.
 

diff --git a/source/Public/Add-SqlDscNode.ps1 b/source/Public/Add-SqlDscNode.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Add a SQL Server node to an Failover Cluster instance (FCI).

diff --git a/source/Public/Add-SqlDscTraceFlag.ps1 b/source/Public/Add-SqlDscTraceFlag.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Add trace flags to a Database Engine instance.

diff --git a/source/Public/Complete-SqlDscFailoverCluster.ps1 b/source/Public/Complete-SqlDscFailoverCluster.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Completes the SQL Server instance installation in the Failover Cluster

diff --git a/source/Public/Complete-SqlDscImage.ps1 b/source/Public/Complete-SqlDscImage.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Completes the image installation of an SQL Server instance.

diff --git a/source/Public/Connect-SqlDscDatabaseEngine.ps1 b/source/Public/Connect-SqlDscDatabaseEngine.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Connect to a SQL Server Database Engine and return the server object.

diff --git a/source/Public/ConvertFrom-SqlDscDatabasePermission.ps1 b/source/Public/ConvertFrom-SqlDscDatabasePermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Converts a DatabasePermission object into an object of the type

diff --git a/source/Public/ConvertFrom-SqlDscServerPermission.ps1 b/source/Public/ConvertFrom-SqlDscServerPermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Converts a ServerPermission object into an object of the type

diff --git a/source/Public/ConvertTo-SqlDscDatabasePermission.ps1 b/source/Public/ConvertTo-SqlDscDatabasePermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Converts a collection of Microsoft.SqlServer.Management.Smo.DatabasePermissionInfo

diff --git a/source/Public/ConvertTo-SqlDscServerPermission.ps1 b/source/Public/ConvertTo-SqlDscServerPermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Converts a collection of Microsoft.SqlServer.Management.Smo.ServerPermissionInfo

diff --git a/source/Public/Disable-SqlDscAudit.ps1 b/source/Public/Disable-SqlDscAudit.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Disables a server audit.

diff --git a/source/Public/Disconnect-SqlDscDatabaseEngine.ps1 b/source/Public/Disconnect-SqlDscDatabaseEngine.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Disconnect from a SQL Server Database Engine instance.

diff --git a/source/Public/Enable-SqlDscAudit.ps1 b/source/Public/Enable-SqlDscAudit.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Enables a server audit.

diff --git a/source/Public/Get-SqlDscAudit.ps1 b/source/Public/Get-SqlDscAudit.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Get server audit.

diff --git a/source/Public/Get-SqlDscConfigurationOption.ps1 b/source/Public/Get-SqlDscConfigurationOption.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Get server configuration option.

diff --git a/source/Public/Get-SqlDscDatabasePermission.ps1 b/source/Public/Get-SqlDscDatabasePermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Returns the current permissions for the database principal.

diff --git a/source/Public/Get-SqlDscManagedComputer.ps1 b/source/Public/Get-SqlDscManagedComputer.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Returns the managed computer object.

diff --git a/source/Public/Get-SqlDscManagedComputerService.ps1 b/source/Public/Get-SqlDscManagedComputerService.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Returns one or more managed computer service objects.

diff --git a/source/Public/Get-SqlDscPreferredModule.ps1 b/source/Public/Get-SqlDscPreferredModule.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Get the first available (preferred) module that is installed.

diff --git a/source/Public/Get-SqlDscServerPermission.ps1 b/source/Public/Get-SqlDscServerPermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Returns the current permissions for the principal.

diff --git a/source/Public/Get-SqlDscStartupParameter.ps1 b/source/Public/Get-SqlDscStartupParameter.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Get current startup parameters on a Database Engine instance.

diff --git a/source/Public/Get-SqlDscTraceFlag.ps1 b/source/Public/Get-SqlDscTraceFlag.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Get current trace flags on a Database Engine instance.

diff --git a/source/Public/Import-SqlDscPreferredModule.ps1 b/source/Public/Import-SqlDscPreferredModule.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Imports a (preferred) module in a standardized way.

diff --git a/source/Public/Initialize-SqlDscRebuildDatabase.ps1 b/source/Public/Initialize-SqlDscRebuildDatabase.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Rebuilds the system databases for an SQL Server instance.

diff --git a/source/Public/Install-SqlDscServer.ps1 b/source/Public/Install-SqlDscServer.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Executes an setup action using Microsoft SQL Server setup executable.

diff --git a/source/Public/Invoke-SqlDscQuery.ps1 b/source/Public/Invoke-SqlDscQuery.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Executes a query on the specified database.

diff --git a/source/Public/New-SqlDscAudit.ps1 b/source/Public/New-SqlDscAudit.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Creates a server audit.

diff --git a/source/Public/Remove-SqlDscAudit.ps1 b/source/Public/Remove-SqlDscAudit.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Removes a server audit.

diff --git a/source/Public/Remove-SqlDscNode.ps1 b/source/Public/Remove-SqlDscNode.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Removes a SQL Server node from an Failover Cluster instance (FCI).

diff --git a/source/Public/Remove-SqlDscTraceFlag.ps1 b/source/Public/Remove-SqlDscTraceFlag.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Removes trace flags from a Database Engine instance.

diff --git a/source/Public/Repair-SqlDscServer.ps1 b/source/Public/Repair-SqlDscServer.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Executes an setup action using Microsoft SQL Server setup executable.

diff --git a/source/Public/Set-SqlDscAudit.ps1 b/source/Public/Set-SqlDscAudit.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Updates a server audit.

diff --git a/source/Public/Set-SqlDscDatabasePermission.ps1 b/source/Public/Set-SqlDscDatabasePermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Set permission for a database principal.

diff --git a/source/Public/Set-SqlDscServerPermission.ps1 b/source/Public/Set-SqlDscServerPermission.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Set permission for a login.

diff --git a/source/Public/Set-SqlDscStartupParameter.ps1 b/source/Public/Set-SqlDscStartupParameter.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Sets startup parameters on a Database Engine instance.

diff --git a/source/Public/Set-SqlDscTraceFlag.ps1 b/source/Public/Set-SqlDscTraceFlag.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Sets trace flags on a Database Engine instance.

diff --git a/source/Public/Test-SqlDscIsDatabasePrincipal.ps1 b/source/Public/Test-SqlDscIsDatabasePrincipal.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Returns whether the database principal exist.

diff --git a/source/Public/Test-SqlDscIsLogin.ps1 b/source/Public/Test-SqlDscIsLogin.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Returns whether the database principal exist.

diff --git a/source/Public/Test-SqlDscIsSupportedFeature.ps1 b/source/Public/Test-SqlDscIsSupportedFeature.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Tests that a feature is supported by a Microsoft SQL Server major version.

diff --git a/source/Public/Uninstall-SqlDscServer.ps1 b/source/Public/Uninstall-SqlDscServer.ps1
@@ -1,3 +1,4 @@
+
 <#
     .SYNOPSIS
         Uninstall features from a Microsoft SQL Server instance.