Merge pull request #157 from CodeLingoBot/rewrite

bcomnes · web-flow · commit 60bfa0c10ff1 · 2019-04-19T15:24:24.000-07:00
Fix function comments based on best practices from Effective Go
diff --git a/go/porcelain/site.go b/go/porcelain/site.go
@@ -62,7 +62,7 @@ func (n *Netlify) UpdateSite(ctx context.Context, site *models.SiteSetup) (*mode
 	return resp.Payload, nil
 }
 
-// ConfigureSiteTLS provisions a TLS certificate for a site with a custom domain.
+// ConfigureSiteTLSCertificate provisions a TLS certificate for a site with a custom domain.
 // It uses Let's Encrypt if the certificate is empty.
 func (n *Netlify) ConfigureSiteTLSCertificate(ctx context.Context, siteID string, cert *CustomTLSCertificate) (*models.SniCertificate, error) {
 	authInfo := context.GetAuthInfo(ctx)

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ func (n Netlify) UpdateSite(ctx context.Context, site models.SiteSetup) (*mode`
`62`	`62`	`return resp.Payload, nil`
`63`	`63`	`}`
`64`	`64`
`65`		`-// ConfigureSiteTLS provisions a TLS certificate for a site with a custom domain.`
	`65`	`+// ConfigureSiteTLSCertificate provisions a TLS certificate for a site with a custom domain.`
`66`	`66`	`// It uses Let's Encrypt if the certificate is empty.`
`67`	`67`	`func (n Netlify) ConfigureSiteTLSCertificate(ctx context.Context, siteID string, cert CustomTLSCertificate) (*models.SniCertificate, error) {`
`68`	`68`	`authInfo := context.GetAuthInfo(ctx)`