Skip to content

Commit 3cefc7a

Browse files
ldezdmke
andauthored
chore: fix grammar and typo (#1978)
Co-authored-by: Dominik Menke <[email protected]>
1 parent f582d12 commit 3cefc7a

File tree

74 files changed

+109
-118
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+109
-118
lines changed

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ Cancelled due to a CI issue, replaced by v4.5.2.
477477
- **[dnsprovider]** azure: Allow for the use of MSI
478478
- **[dnsprovider]** constellix: improve challenge.
479479
- **[dnsprovider]** godaddy: allow parallel solve.
480-
- **[dnsprovider]** namedotcom: get the actual registered domain so we can remove just that from the hostname to be created
480+
- **[dnsprovider]** namedotcom: get the actual registered domain, so we can remove just that from the hostname to be created
481481
- **[dnsprovider]** transip: updated the client to v6
482482

483483
### Fixed:
@@ -581,7 +581,7 @@ Cancelled due to a CI issue, replaced by v4.5.2.
581581

582582
## [v3.0.1] - 2019-08-14
583583

584-
There was a problem when creating the tag v3.0.1, this tag has been invalidate.
584+
There was a problem when creating the tag v3.0.1, this tag has been invalidated.
585585

586586
## [v3.0.0] - 2019-08-05
587587

@@ -873,7 +873,7 @@ There was a problem when creating the tag v3.0.1, this tag has been invalidate.
873873
- lib: The `DeleteRegistration` function on `acme.Client`. This deletes the registration as currently configured in the client.
874874
- lib: The `ObtainCertificateForCSR` function on `acme.Client`. The function allows to request a certificate for an already existing CSR.
875875
- CLI: The `--csr` switch. Allows to use already existing CSRs for certificate requests on the command line.
876-
- CLI: The `--pem` flag. This will change the certificate output so it outputs a .pem file concatanating the .key and .crt files together.
876+
- CLI: The `--pem` flag. This will change the certificate output, so it outputs a .pem file concatanating the .key and .crt files together.
877877
- CLI: The `--dns-resolvers` flag. Allows for users to override the default DNS servers used for recursive lookup.
878878
- lib: Added a memcached provider for the HTTP challenge.
879879
- CLI: The `--memcached-host` flag. This allows to use memcached for challenge storage.
@@ -895,11 +895,11 @@ There was a problem when creating the tag v3.0.1, this tag has been invalidate.
895895
- lib: The library will now skip challenge solving if a valid Authz already exists.
896896

897897
### Removed:
898-
- lib: The library will no longer check for auto renewed certificates. This has been removed from the spec and is not supported in Boulder.
898+
- lib: The library will no longer check for auto-renewed certificates. This has been removed from the spec and is not supported in Boulder.
899899

900900
### Fixed:
901901
- lib: Fix a problem with the Route53 provider where it was possible the verification was published to a private zone.
902-
- lib: Loading an account from file should fail if a integral part is nil
902+
- lib: Loading an account from file should fail if an integral part is nil
903903
- lib: Fix a potential issue where the Dyn provider could resolve to an incorrect zone.
904904
- lib: If a registration encounteres a conflict, the old registration is now recovered.
905905
- CLI: The account.json file no longer has the executable flag set.
@@ -967,7 +967,7 @@ There was a problem when creating the tag v3.0.1, this tag has been invalidate.
967967

968968
### Changed:
969969
- lib: NewClient does no longer accept the optPort parameter
970-
- lib: ObtainCertificate now returns a SAN certificate if you pass more then one domain.
970+
- lib: ObtainCertificate now returns a SAN certificate if you pass more than one domain.
971971
- lib: GetOCSPForCert now returns the parsed OCSP response instead of just the status.
972972
- lib: ObtainCertificate has a new parameter `privKey crypto.PrivateKey` which lets you reuse an existing private key for new certificates.
973973
- lib: RenewCertificate now expects the PrivateKey property of the CertificateResource to be set only if you want to reuse the key.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To ensure a great and easy experience for everyone, please review the few guidel
77

88
- Use the issue search to see if the issue has already been reported.
99
- Also look for closed issues to see if your issue has already been fixed.
10-
- If both of the above do not apply create a new issue and include as much information as possible.
10+
- If both of the above do not apply, create a new issue and include as much information as possible.
1111

1212
Bug reports should include all information a person could need to reproduce your problem without the need to
1313
follow up for more information. If possible, provide detailed steps for us to reproduce it, the expected behaviour and the actual behaviour.

acme/api/internal/nonces/nonce_manager.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ func (n *Manager) getNonce() (string, error) {
6363
return GetFromResponse(resp)
6464
}
6565

66-
// GetFromResponse Extracts a nonce from a HTTP response.
66+
// GetFromResponse Extracts a nonce from an HTTP response.
6767
func GetFromResponse(resp *http.Response) (string, error) {
6868
if resp == nil {
6969
return "", errors.New("nil response")

acme/commons.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ type Meta struct {
7171

7272
// externalAccountRequired (optional, boolean):
7373
// If this field is present and set to "true",
74-
// then the CA requires that all new- account requests include an "externalAccountBinding" field
74+
// then the CA requires that all new-account requests include an "externalAccountBinding" field
7575
// associating the new account with an external account.
7676
ExternalAccountRequired bool `json:"externalAccountRequired"`
7777
}
7878

79-
// ExtendedAccount a extended Account.
79+
// ExtendedAccount an extended Account.
8080
type ExtendedAccount struct {
8181
Account
8282
// Contains the value of the response header `Location`
@@ -91,7 +91,7 @@ type Account struct {
9191
// The status of this account.
9292
// Possible values are: "valid", "deactivated", and "revoked".
9393
// The value "deactivated" should be used to indicate client-initiated deactivation
94-
// whereas "revoked" should be used to indicate server- initiated deactivation. (See Section 7.1.6)
94+
// whereas "revoked" should be used to indicate server-initiated deactivation. (See Section 7.1.6)
9595
Status string `json:"status,omitempty"`
9696

9797
// contact (optional, array of string):
@@ -321,7 +321,7 @@ type RenewalInfoResponse struct {
321321
// SuggestedWindow contains two fields, start and end,
322322
// whose values are timestamps which bound the window of time in which the CA recommends renewing the certificate.
323323
SuggestedWindow Window `json:"suggestedWindow"`
324-
// ExplanationURL is a optional URL pointing to a page which may explain why the suggested renewal window is what it is.
324+
// ExplanationURL is an optional URL pointing to a page which may explain why the suggested renewal window is what it is.
325325
// For example, it may be a page explaining the CA's dynamic load-balancing strategy,
326326
// or a page documenting which certificates are affected by a mass revocation event.
327327
// Callers SHOULD provide this URL to their operator, if present.

certcrypto/crypto.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ func ParsePEMBundle(bundle []byte) ([]*x509.Certificate, error) {
8484
// ParsePEMPrivateKey parses a private key from key, which is a PEM block.
8585
// Borrowed from Go standard library, to handle various private key and PEM block types.
8686
// https://github.com/golang/go/blob/693748e9fa385f1e2c3b91ca9acbb6c0ad2d133d/src/crypto/tls/tls.go#L291-L308
87-
// https://github.com/golang/go/blob/693748e9fa385f1e2c3b91ca9acbb6c0ad2d133d/src/crypto/tls/tls.go#L238)
87+
// https://github.com/golang/go/blob/693748e9fa385f1e2c3b91ca9acbb6c0ad2d133d/src/crypto/tls/tls.go#L238
8888
func ParsePEMPrivateKey(key []byte) (crypto.PrivateKey, error) {
8989
keyBlockDER, _ := pem.Decode(key)
9090
if keyBlockDER == nil {

certificate/certificates.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ func (c *Certifier) getForCSR(domains []string, order acme.ExtendedOrder, bundle
292292
}
293293

294294
if respOrder.Status == acme.StatusValid {
295-
// if the certificate is available right away, short cut!
295+
// if the certificate is available right away, shortcut!
296296
ok, errR := c.checkResponse(respOrder, certRes, bundle, preferredChain)
297297
if errR != nil {
298298
return nil, errR

challenge/dns01/nameserver.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ func sendDNSQuery(m *dns.Msg, ns string) (*dns.Msg, error) {
264264

265265
if in != nil && in.Truncated {
266266
tcp := &dns.Client{Net: "tcp", Timeout: dnsTimeout}
267-
// If the TCP request succeeds, the err will reset to nil
267+
// If the TCP request succeeds, the "err" will reset to nil
268268
in, _, err = tcp.Exchange(m, ns)
269269
}
270270

challenge/dns01/precheck_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ func TestCheckDNSPropagation(t *testing.T) {
3737

3838
ok, err := check.checkDNSPropagation(test.fqdn, test.value)
3939
if test.expectError {
40-
assert.Errorf(t, err, "PreCheckDNS must failed for %s", test.fqdn)
41-
assert.False(t, ok, "PreCheckDNS must failed for %s", test.fqdn)
40+
assert.Errorf(t, err, "PreCheckDNS must fail for %s", test.fqdn)
41+
assert.False(t, ok, "PreCheckDNS must fail for %s", test.fqdn)
4242
} else {
4343
assert.NoErrorf(t, err, "PreCheckDNS failed for %s", test.fqdn)
4444
assert.True(t, ok, "PreCheckDNS failed for %s", test.fqdn)

challenge/resolver/prober.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ func sequentialSolve(authSolvers []*selectedAuthSolver, failures obtainError) {
128128
}
129129

130130
func parallelSolve(authSolvers []*selectedAuthSolver, failures obtainError) {
131-
// For all valid preSolvers, first submit the challenges so they have max time to propagate
131+
// For all valid preSolvers, first submit the challenges, so they have max time to propagate
132132
for _, authSolver := range authSolvers {
133133
authz := authSolver.authz
134134
if solvr, ok := authSolver.solver.(preSolver); ok {

challenge/tlsalpn01/tls_alpn_challenge_server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ func (s *ProviderServer) GetAddress() string {
4040
return net.JoinHostPort(s.iface, s.port)
4141
}
4242

43-
// Present generates a certificate with a SHA-256 digest of the keyAuth provided
43+
// Present generates a certificate with an SHA-256 digest of the keyAuth provided
4444
// as the acmeValidation-v1 extension value to conform to the ACME-TLS-ALPN spec.
4545
func (s *ProviderServer) Present(domain, token, keyAuth string) error {
4646
if s.port == "" {

0 commit comments

Comments
 (0)