diff --git a/docs/directives.md b/docs/directives.md index 1d9d0d79de3..392a207c2ef 100644 --- a/docs/directives.md +++ b/docs/directives.md @@ -355,7 +355,10 @@ directive: The same can be done with cmdlets. ### Table Formatting -This allows you to set the *table format* for a model. This updates the `.format.ps1xml` to have the format described below as opposed to the automatic table format that is created at build-time. For example, we are updating the format for a VirtualMachine model to only show the Name and ResourceGroup properties. It updates the column label for ResourceGroup to Resource Group and sets the columns widths for Name and ResourceGroup: + +Table is the default output format of cmdlets generated by autorest.powershell. Check out [these guidelines](https://github.com/Azure/azure-powershell/blob/main/documentation/development-docs/design-guidelines/cmdlet-best-practices.md#output-format) to design the output format. + +The `format-table` directive allows you to set the *table format* for a model. This updates the `.format.ps1xml` to have the format described below as opposed to the automatic table format that is created at build-time. For example, we are updating the format for a VirtualMachine model to only show the Name and ResourceGroup properties. It updates the column label for ResourceGroup to Resource Group and sets the columns widths for Name and ResourceGroup: ```yaml $false directive: - where: