Add detailed .OUTPUTS documentation#10072
Merged
potatoqualitee merged 5 commits intodevelopmentfrom Dec 30, 2025
Merged
Conversation
Added a comprehensive .OUTPUTS section to Add-DbaAgDatabase, documenting the default and additional properties of the returned AvailabilityDatabase objects. This includes descriptions and data types for each property, clarifies which are shown by default, and notes that all SMO properties are available via Select-Object.
Replaces the previous JSON output format example with detailed PowerShell .OUTPUTS comment-based help examples. Adds multiple scenarios, guidelines for documenting output types and properties, and clarifies how to describe default and conditional outputs for PowerShell commands.
Get-DbaHelp now includes an Outputs section in its rendered documentation if output information is available. This improves the clarity of command documentation by displaying expected return values.
(do Add-DbaAgListener)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
.OUTPUTSdocumentation to several PowerShell command files, ensuring that users have clear, accurate descriptions of what each function returns. It also enhances the internal help system to display this new information. The changes improve usability and maintainability by making output types and properties explicit for each command.Help System Enhancements
Help Rendering Improvements:
Get-DbaHelpto display the.OUTPUTSsection in the rendered help output, if present..OUTPUTSsection from command help and make it available for display.