Skip to content

Commit ef85fa7

Browse files
committedSep 14, 2024··
Grammar fixes
Signed-off-by: Nathan Baulch <nathan.baulch@gmail.com>
1 parent ff9dd26 commit ef85fa7

File tree

21 files changed

+25
-26
lines changed

21 files changed

+25
-26
lines changed
 

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ Like any good open source project, we use Pull Requests (PRs) to track code chan
274274

275275
#### Documentation PRs
276276

277-
Documentation PRs should be made on the docs repo: <https://github.com/helm/helm-www>. Keeping Helm's documentation up to date is highly desirable, and it is recommend all user facing changes. Accurate and helpful documentation is critical for effectively communicating Helm's behavior to a wide audience.
277+
Documentation PRs should be made on the docs repo: <https://github.com/helm/helm-www>. Keeping Helm's documentation up to date is highly desirable, and is recommended for all user facing changes. Accurate and helpful documentation is critical for effectively communicating Helm's behavior to a wide audience.
278278

279279
Small, ad-hoc changes/PRs to Helm which introduce user facing changes, which would benefit from documentation changes, should apply the `docs needed` label. Larger changes associated with a HIP should track docs via that HIP. The `docs needed` label doesn't block PRs, and maintainers/PR reviewers should apply discretion judging in whether the `docs needed` label should be applied.
280280

‎cmd/helm/load_plugins.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ func addPluginCommands(plugin *plugin.Plugin, baseCmd *cobra.Command, cmds *plug
286286
f.BoolP(longs[i], shorts[i], false, "")
287287
} else {
288288
// Create a long flag with the same name as the short flag.
289-
// Not a perfect solution, but its better than ignoring the extra short flags.
289+
// Not a perfect solution, but it's better than ignoring the extra short flags.
290290
f.BoolP(shorts[i], shorts[i], false, "")
291291
}
292292
}

‎cmd/helm/search_repo.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ func (o *searchRepoOptions) setupSearchedVersion() {
139139
if o.devel { // search for releases and prereleases (alpha, beta, and release candidate releases).
140140
debug("setting version to >0.0.0-0")
141141
o.version = ">0.0.0-0"
142-
} else { // search only for stable releases, prerelease versions will be skip
142+
} else { // search only for stable releases, prerelease versions will be skipped
143143
debug("setting version to >0.0.0")
144144
o.version = ">0.0.0"
145145
}

‎cmd/helm/testdata/testcharts/chart-with-template-lib-dep/charts/common/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Note that the `common.service` template defines two parameters:
4848
- A template name containing the service definition overrides
4949

5050
A limitation of the Go template library is that a template can only take a
51-
single argument. The `list` function is used to workaround this by constructing
51+
single argument. The `list` function is used to work around this by constructing
5252
a list or array of arguments that is passed to the template.
5353

5454
The `common.service` template is responsible for rendering the templates with

‎cmd/helm/testdata/testcharts/lib-chart/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Note that the `common.service` template defines two parameters:
4848
- A template name containing the service definition overrides
4949

5050
A limitation of the Go template library is that a template can only take a
51-
single argument. The `list` function is used to workaround this by constructing
51+
single argument. The `list` function is used to work around this by constructing
5252
a list or array of arguments that is passed to the template.
5353

5454
The `common.service` template is responsible for rendering the templates with

‎internal/resolver/resolver.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ func (r *Resolver) Resolve(reqs []*chart.Dependency, repoNames map[string]string
172172
Repository: d.Repository,
173173
Version: version,
174174
}
175-
// The version are already sorted and hence the first one to satisfy the constraint is used
175+
// The versions are already sorted and hence the first one to satisfy the constraint is used
176176
for _, ver := range vs {
177177
v, err := semver.NewVersion(ver.Version)
178178
// OCI does not need URLs

‎internal/third_party/dep/fs/fs.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ func fixLongPath(path string) string {
260260
// minus 12)." Since MAX_PATH is 260, 260 - 12 = 248.
261261
//
262262
// The MSDN docs appear to say that a normal path that is 248 bytes long
263-
// will work; empirically the path must be less then 248 bytes long.
263+
// will work; empirically the path must be less than 248 bytes long.
264264
if len(path) < 248 {
265265
// Don't fix. (This is how Go 1.7 and earlier worked,
266266
// not automatically generating the \\?\ form)

‎internal/tlsutil/tls.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ func CertPoolFromFile(filename string) (*x509.CertPool, error) {
6565
return cp, nil
6666
}
6767

68-
// CertFromFilePair returns an tls.Certificate containing the
68+
// CertFromFilePair returns a tls.Certificate containing the
6969
// certificates public/private key pair from a pair of given PEM-encoded files.
7070
// Returns an error if the file could not be read, a certificate could not
7171
// be parsed, or if the file does not contain any certificates

‎pkg/action/install.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ func createOrOpenFile(filename string, append bool) (*os.File, error) {
631631
return os.Create(filename)
632632
}
633633

634-
// check if the directory exists to create file. creates if don't exist
634+
// check if the directory exists to create file. creates if doesn't exist
635635
func ensureDirectoryForFile(file string) error {
636636
baseDir := path.Dir(file)
637637
_, err := os.Stat(baseDir)

‎pkg/action/testdata/charts/chart-with-uncompressed-dependencies/values.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ externalDatabase:
7474
## Database host
7575
host: localhost
7676

77-
## non-root Username for Wordpress Database
77+
## non-root Username for WordPress Database
7878
user: bn_wordpress
7979

8080
## Database password
@@ -102,7 +102,7 @@ mariadb:
102102
db:
103103
name: bitnami_wordpress
104104
user: bn_wordpress
105-
## If the password is not specified, mariadb will generates a random password
105+
## If the password is not specified, mariadb will generate a random password
106106
##
107107
# password:
108108

@@ -165,7 +165,7 @@ readinessProbe:
165165
successThreshold: 1
166166

167167
## Configure the ingress resource that allows you to access the
168-
## Wordpress installation. Set up the URL
168+
## WordPress installation. Set up the URL
169169
## ref: http://kubernetes.io/docs/user-guide/ingress/
170170
##
171171
ingress:

‎pkg/chart/loader/archive.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ func ensureArchive(name string, raw *os.File) error {
101101
return nil
102102
}
103103

104-
// isGZipApplication checks whether the achieve is of the application/x-gzip type.
104+
// isGZipApplication checks whether the archive is of the application/x-gzip type.
105105
func isGZipApplication(data []byte) bool {
106106
sig := []byte("\x1F\x8B\x08")
107107
return bytes.HasPrefix(data, sig)

‎pkg/chartutil/dependencies.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ func processDependencyEnabled(c *chart.Chart, v map[string]interface{}, path str
137137
// If any dependency is not a part of Chart.yaml
138138
// then this should be added to chartDependencies.
139139
// However, if the dependency is already specified in Chart.yaml
140-
// we should not add it, as it would be anyways processed from Chart.yaml
140+
// we should not add it, as it would be processed from Chart.yaml anyway.
141141

142142
Loop:
143143
for _, existing := range c.Dependencies() {

‎pkg/cli/output/output.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ func (o Format) Write(out io.Writer, w Writer) error {
7373
}
7474

7575
// ParseFormat takes a raw string and returns the matching Format.
76-
// If the format does not exists, ErrInvalidFormatType is returned
76+
// If the format does not exist, ErrInvalidFormatType is returned
7777
func ParseFormat(s string) (out Format, err error) {
7878
switch s {
7979
case Table.String():

‎pkg/helmpath/lazypath.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ const (
3434
DataHomeEnvVar = "HELM_DATA_HOME"
3535
)
3636

37-
// lazypath is an lazy-loaded path buffer for the XDG base directory specification.
37+
// lazypath is a lazy-loaded path buffer for the XDG base directory specification.
3838
type lazypath string
3939

4040
func (l lazypath) path(helmEnvVar, xdgEnvVar string, defaultFn func() string, elem ...string) string {

‎pkg/ignore/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The formatting rules are as follows:
2626
2727
- Parsing is line-by-line
2828
- Empty lines are ignored
29-
- Lines the begin with # (comments) will be ignored
29+
- Lines that begin with # (comments) will be ignored
3030
- Leading and trailing spaces are always ignored
3131
- Inline comments are NOT supported ('foo* # Any foo' does not contain a comment)
3232
- There is no support for multi-line patterns

‎pkg/kube/client.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,7 @@ func createPatch(target *resource.Info, current runtime.Object) ([]byte, types.P
634634
// Get a versioned object
635635
versionedObject := AsVersioned(target)
636636

637-
// Unstructured objects, such as CRDs, may not have an not registered error
637+
// Unstructured objects, such as CRDs, may not have a not registered error
638638
// returned from ConvertToVersion. Anything that's unstructured should
639639
// use the jsonpatch.CreateMergePatch. Strategic Merge Patch is not supported
640640
// on objects like CRDs.

‎pkg/registry/util.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ func GetTagMatchingVersionOrConstraint(tags []string, versionString string) (str
6565
// If string is empty, set wildcard constraint
6666
constraint, _ = semver.NewConstraint("*")
6767
} else {
68-
// when customer input exact version, check whether have exact match
69-
// one first
68+
// when customer inputs specific version, check whether there's an exact match first
7069
for _, v := range tags {
7170
if versionString == v {
7271
return v, nil

‎pkg/release/status.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ const (
3131
StatusSuperseded Status = "superseded"
3232
// StatusFailed indicates that the release was not successfully deployed.
3333
StatusFailed Status = "failed"
34-
// StatusUninstalling indicates that a uninstall operation is underway.
34+
// StatusUninstalling indicates that an uninstall operation is underway.
3535
StatusUninstalling Status = "uninstalling"
3636
// StatusPendingInstall indicates that an install operation is underway.
3737
StatusPendingInstall Status = "pending-install"
3838
// StatusPendingUpgrade indicates that an upgrade operation is underway.
3939
StatusPendingUpgrade Status = "pending-upgrade"
40-
// StatusPendingRollback indicates that an rollback operation is underway.
40+
// StatusPendingRollback indicates that a rollback operation is underway.
4141
StatusPendingRollback Status = "pending-rollback"
4242
)
4343

‎pkg/repo/index.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ func (i IndexFile) Get(name, version string) (*ChartVersion, error) {
200200
}
201201
}
202202

203-
// when customer input exact version, check whether have exact match one first
203+
// when customer inputs specific version, check whether there's an exact match first
204204
if len(version) != 0 {
205205
for _, ver := range vs {
206206
if version == ver.Version {

‎pkg/storage/driver/mock_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ func (mock *MockConfigMapsInterface) Get(_ context.Context, name string, _ metav
120120
return object, nil
121121
}
122122

123-
// List returns the a of ConfigMaps.
123+
// List returns all ConfigMaps.
124124
func (mock *MockConfigMapsInterface) List(_ context.Context, opts metav1.ListOptions) (*v1.ConfigMapList, error) {
125125
var list v1.ConfigMapList
126126

@@ -206,7 +206,7 @@ func (mock *MockSecretsInterface) Get(_ context.Context, name string, _ metav1.G
206206
return object, nil
207207
}
208208

209-
// List returns the a of Secret.
209+
// List returns all Secrets.
210210
func (mock *MockSecretsInterface) List(_ context.Context, opts metav1.ListOptions) (*v1.SecretList, error) {
211211
var list v1.SecretList
212212

‎pkg/time/time.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ limitations under the License.
1515
*/
1616

1717
// Package time contains a wrapper for time.Time in the standard library and
18-
// associated methods. This package mainly exists to workaround an issue in Go
18+
// associated methods. This package mainly exists to work around an issue in Go
1919
// where the serializer doesn't omit an empty value for time:
2020
// https://github.com/golang/go/issues/11939. As such, this can be removed if a
2121
// proposal is ever accepted for Go

0 commit comments

Comments
 (0)
Please sign in to comment.