Skip to content

Commit

Permalink
Fix typos (#324)
Browse files Browse the repository at this point in the history
  • Loading branch information
deining authored Jan 3, 2025
1 parent 2cfc589 commit f7a9441
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Here are some of the expectations we have of contributors:

- **Benchmarks should be included for optimizations.** Optimizations sometimes make code harder to read or have changes that are less than obvious. They should be proven with benchmarks or profiling.

- **[Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) insignificant commits.** Every commit should be significant. Commits which merely rewrite a comment or fix a typo can be combined into another commit that has more substance. Interactive rebase can do this, or a simpler way is `git reset --soft <diverging-commit>` then `git commit -s`.
- **[Squash](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) insignificant commits.** Every commit should be significant. Commits which merely rewrite a comment or fix a typo can be combined into another commit that has more substance. Interactive rebase can do this, or a simpler way is `git reset --soft <diverging-commit>` then `git commit -s`.

- **Maintain your contributions.** Please help maintain your change after it is merged.

Expand Down Expand Up @@ -73,7 +73,7 @@ Please follow the issue template so we have all the needed information. Unredact

Failure to fill out the issue template will probably result in the issue being closed.

We suggest reading [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
We suggest reading [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html).

Please be kind. :smile: Remember that CertMagic comes at no cost to you, and you're getting free support when we fix your issues. If we helped you, please consider helping someone else!

Expand Down
2 changes: 1 addition & 1 deletion acmeissuer.go
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ func NewACMEIssuer(cfg *Config, template ACMEIssuer) *ACMEIssuer {
}

// IssuerKey returns the unique issuer key for the
// confgured CA endpoint.
// configured CA endpoint.
func (am *ACMEIssuer) IssuerKey() string {
return am.issuerKey(am.CA)
}
Expand Down
4 changes: 2 additions & 2 deletions certificates.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func (cfg *Config) certNeedsRenewal(leaf *x509.Certificate, ari acme.RenewalInfo
// (notice that we don't strictly require an ARI window to also exist; we presume
// that if a time has been selected, a window does or did exist, even if it didn't
// get stored/encoded for some reason - but also: this allows administrators to
// manually or explicitly schedule a renewal time indepedently of ARI which could
// manually or explicitly schedule a renewal time independently of ARI which could
// be useful)
selectedTime := ari.SelectedTime

Expand Down Expand Up @@ -145,7 +145,7 @@ func (cfg *Config) certNeedsRenewal(leaf *x509.Certificate, ari acme.RenewalInfo
// possibility of a bug in ARI compromising a site's uptime: we should always always
// always give heed to actual validity period
if currentlyInRenewalWindow(leaf.NotBefore, expiration, 1.0/20.0) {
logger.Warn("certificate is in emergency renewal window; superceding ARI",
logger.Warn("certificate is in emergency renewal window; superseding ARI",
zap.Duration("remaining", time.Until(expiration)),
zap.Time("renewal_cutoff", cutoff))
return true
Expand Down
4 changes: 2 additions & 2 deletions certmagic.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
// you use this lower-level API, you'll have to be sure to solve the HTTP
// and TLS-ALPN challenges yourself (unless you disabled them or use the
// DNS challenge) by using the provided Config.GetCertificate function
// in your tls.Config and/or Config.HTTPChallangeHandler in your HTTP
// in your tls.Config and/or Config.HTTPChallengeHandler in your HTTP
// handler.
//
// See the package's README for more instruction.
Expand Down Expand Up @@ -261,7 +261,7 @@ func ManageAsync(ctx context.Context, domainNames []string) error {
// containing the names passed into those functions if
// no DecisionFunc is set. This ensures some degree of
// control by default to avoid certificate operations for
// aribtrary domain names. To override this whitelist,
// arbitrary domain names. To override this whitelist,
// manually specify a DecisionFunc. To impose rate limits,
// specify your own DecisionFunc.
type OnDemandConfig struct {
Expand Down
2 changes: 1 addition & 1 deletion dnsutil_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ func TestResolveConfServers(t *testing.T) {
expected: []string{"10.200.3.249", "10.200.3.250:5353", "2001:4860:4860::8844", "[10.0.0.1]:5353"},
},
{
fixture: "testdata/resolv.conf.nonexistant",
fixture: "testdata/resolv.conf.nonexistent",
defaults: []string{"127.0.0.1:53"},
expected: []string{"127.0.0.1:53"},
},
Expand Down
2 changes: 1 addition & 1 deletion handshake.go
Original file line number Diff line number Diff line change
Expand Up @@ -958,6 +958,6 @@ type helloInfoCtxKey string
// a context.Context within a DecisionFunc. However, be advised that it is best practice
// that the decision whether to obtain a certificate is be based solely on the name,
// not other properties of the specific connection/client requesting the connection.
// For example, it is not adviseable to use a client's IP address to decide whether to
// For example, it is not advisable to use a client's IP address to decide whether to
// allow a certificate. Instead, the ClientHello can be useful for logging, etc.
const ClientHelloInfoCtxKey helloInfoCtxKey = "certmagic:ClientHelloInfo"

0 comments on commit f7a9441

Please sign in to comment.