vmware / powershell-module-for-vmware-cloud-foundation-power-management

PowerShell Module for VMware Cloud Foundation Power Management
https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-power-management/
BSD 2-Clause "Simplified" License
10 stars 8 forks source link

Update each cmdlet to include the `.PARAMETER` details #23

Closed tenthirtyam closed 1 year ago

tenthirtyam commented 1 year ago

Code of Conduct

Description

Update each module cmdlet to include the .PARAMETER for each cmdlet parameter.

This will be used to generate the documentation and provide better help.

Use Case(s)

Potential Configuration

The .PARAMETER for each cmdlet parameter should be similar to the following:

        ...

        .PARAMETER server
        The FQDN of the SDDC Manager appliance.

        .PARAMETER user
        The username to authenticate to SDDC Manager.

        .PARAMETER pass
        The password to authenticate to SDDC Manager.

        .PARAMETER domain
        The name of the workload domain to retrieve the vCenter Server details from SDDC Manager for the connection object.

        ...

See VMware.CloudFoundation.PasswordManagement as an example.

References

No response

github-actions[bot] commented 1 year ago

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.