Merge pull request #256 from heroku/newclient-doc-fix

Fix documentation for acme.NewClient
This commit is contained in:
xenolf 2016-08-05 14:04:00 +02:00 committed by GitHub
commit aa216e0399

View file

@ -58,8 +58,9 @@ type Client struct {
} }
// NewClient creates a new ACME client on behalf of the user. The client will depend on // NewClient creates a new ACME client on behalf of the user. The client will depend on
// the ACME directory located at caDirURL for the rest of its actions. It will // the ACME directory located at caDirURL for the rest of its actions. A private
// generate private keys for certificates of size keyBits. // key of type keyType (see KeyType contants) will be generated when requesting a new
// certificate if one isn't provided.
func NewClient(caDirURL string, user User, keyType KeyType) (*Client, error) { func NewClient(caDirURL string, user User, keyType KeyType) (*Client, error) {
privKey := user.GetPrivateKey() privKey := user.GetPrivateKey()
if privKey == nil { if privKey == nil {