search

ebekker / ACMESharp

An ACME client library and PowerShell client for the .NET platform (Let's Encrypt)
https://pkisharp.github.io/ACMESharp-docs/
1.21k stars 184 forks source link

Cmdlet documentation incorrect and incomplete #333

Closed alexhass closed 5 years ago

alexhass commented 6 years ago

First step in fixing the inconsistencies.

ebekker commented 5 years ago

The problem with these changes is that they're not quite right. The ACME prefix in the noun part of the cmdlet is not a part of the actual cmdlet name. It's the 'default' prefix assigned in the module manifest. When you load the module, you can override this default prefix and it would actually be named differently, for example, if you do:

import-module ACMESharp -Prefix LetsEncrypt

Then your cmdlet names would differ, for example:

 New-LetsEncryptIdentifier

If you change the name of the linked cmdlets as you've done here, I believe it would break the links because those are not the actual cmdlet names when the docs are generated.