Clarify OUTPUTS section in Test-SqlDscDatabaseProperty documentation to specify return value based on database properties state.

johlju · johlju · commit b23b503f7343 · 2025-12-03T22:25:55.000+01:00
diff --git a/source/Public/Test-SqlDscDatabaseProperty.ps1 b/source/Public/Test-SqlDscDatabaseProperty.ps1
@@ -497,6 +497,8 @@
 
     .OUTPUTS
         `System.Boolean`
+
+        Returns `$true` if the database properties are in the desired state; otherwise `$false`.
 #>
 function Test-SqlDscDatabaseProperty
 {

Original file line number	Diff line number	Diff line change
`@@ -497,6 +497,8 @@`
`497`	`497`
`498`	`498`	`.OUTPUTS`
`499`	`499`	`System.Boolean`
	`500`	`+`
	`501`	+ Returns `$true` if the database properties are in the desired state; otherwise `$false`.
`500`	`502`	`#>`
`501`	`503`	`function Test-SqlDscDatabaseProperty`
`502`	`504`	`{`