Skip to content

Commit 1935e60

Browse files
survivantMrAlias
andauthored
Fix typos and linguistic errors in documentation / hacktoberfest (#7494)
Fix typos and linguistic errors in documentation. It's not much, but I'm happy to help --------- Signed-off-by: Sebastien Dionne <[email protected]> Co-authored-by: Tyler Yahn <[email protected]>
1 parent fa8e48b commit 1935e60

File tree

8 files changed

+20
-21
lines changed

8 files changed

+20
-21
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ go get -d go.opentelemetry.io/otel
5454
(This may print some warning about "build constraints exclude all Go
5555
files", just ignore it.)
5656

57-
This will put the project in `${GOPATH}/src/go.opentelemetry.io/otel`. You
58-
can alternatively use `git` directly with:
57+
This will put the project in `${GOPATH}/src/go.opentelemetry.io/otel`.
58+
Alternatively, you can use `git` directly with:
5959

6060
```sh
6161
git clone https://github.com/open-telemetry/opentelemetry-go
@@ -65,8 +65,7 @@ git clone https://github.com/open-telemetry/opentelemetry-go
6565
that name is a kind of a redirector to GitHub that `go get` can
6666
understand, but `git` does not.)
6767

68-
This would put the project in the `opentelemetry-go` directory in
69-
current working directory.
68+
This will add the project as `opentelemetry-go` within the current directory.
7069

7170
Enter the newly created directory and add your fork as a new remote:
7271

@@ -109,7 +108,7 @@ A PR is considered **ready to merge** when:
109108

110109
This is not enforced through automation, but needs to be validated by the
111110
maintainer merging.
112-
* At least one of the qualified approvals need to be from an
111+
* At least one of the qualified approvals needs to be from an
113112
[Approver]/[Maintainer] affiliated with a different company than the author
114113
of the PR.
115114
* PRs introducing changes that have already been discussed and consensus
@@ -166,11 +165,11 @@ guidelines](https://opentelemetry.io/docs/specs/otel/library-guidelines).
166165
### Focus on Capabilities, Not Structure Compliance
167166

168167
OpenTelemetry is an evolving specification, one where the desires and
169-
use cases are clear, but the method to satisfy those uses cases are
168+
use cases are clear, but the methods to satisfy those use cases are
170169
not.
171170

172171
As such, Contributions should provide functionality and behavior that
173-
conforms to the specification, but the interface and structure is
172+
conforms to the specification, but the interface and structure are
174173
flexible.
175174

176175
It is preferable to have contributions follow the idioms of the
@@ -217,7 +216,7 @@ about dependency compatibility.
217216
This project does not partition dependencies based on the environment (i.e.
218217
`development`, `staging`, `production`).
219218

220-
Only the dependencies explicitly included in the released modules have be
219+
Only the dependencies explicitly included in the released modules have been
221220
tested and verified to work with the released code. No other guarantee is made
222221
about the compatibility of other dependencies.
223222

@@ -635,8 +634,8 @@ is not in their root name.
635634

636635
The use of internal packages should be scoped to a single module. A sub-module
637636
should never import from a parent internal package. This creates a coupling
638-
between the two modules where a user can upgrade the parent without the child
639-
and if the internal package API has changed it will fail to upgrade[^3].
637+
between the two modules where a user can upgrade the parent without the child,
638+
and if the internal package API has changed, it will fail to upgrade[^3].
640639

641640
There are two known exceptions to this rule:
642641

@@ -657,7 +656,7 @@ this.
657656

658657
### Ignoring context cancellation
659658

660-
OpenTelemetry API implementations need to ignore the cancellation of the context that are
659+
OpenTelemetry API implementations need to ignore the cancellation of the context that is
661660
passed when recording a value (e.g. starting a span, recording a measurement, emitting a log).
662661
Recording methods should not return an error describing the cancellation state of the context
663662
when they complete, nor should they abort any work.
@@ -891,7 +890,7 @@ func (i *instrumentation) record(ctx context.Context, value int64, baseAttrs ...
891890

892891
Pools are most effective when there are many pooled objects of the same sufficiently large size, and the objects are repeatedly used.
893892
This amortizes the cost of allocation and synchronization.
894-
Ideally, the pools should be scoped to be used as widely as possible within the component to maximize this efficiency while still ensure correctness.
893+
Ideally, the pools should be scoped to be used as widely as possible within the component to maximize this efficiency while still ensuring correctness.
895894

896895
[`sync.Pool`]: https://pkg.go.dev/sync#Pool
897896

@@ -1079,7 +1078,7 @@ func componentName() attribute.KeyValue {
10791078
```
10801079

10811080
The component ID will need to be resettable for deterministic testing.
1082-
If test are in a different package than the component being tested (i.e. a `<component package>_test` package name), use a generated `counter` internal package to manage the counter.
1081+
If tests are in a different package than the component being tested (i.e. a `<component package>_test` package name), use a generated `counter` internal package to manage the counter.
10831082
See [stdouttrace exporter example](./exporters/stdout/stdouttrace/internal/gen.go) for reference.
10841083

10851084
#### Testing

RELEASING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Ensure things look correct before submitting a pull request to include the addit
2424

2525
## Breaking changes validation
2626

27-
You can run `make gorelease` that runs [gorelease](https://pkg.go.dev/golang.org/x/exp/cmd/gorelease) to ensure that there are no unwanted changes done in the public API.
27+
You can run `make gorelease` which runs [gorelease](https://pkg.go.dev/golang.org/x/exp/cmd/gorelease) to ensure that there are no unwanted changes made in the public API.
2828

2929
You can check/report problems with `gorelease` [here](https://golang.org/issues/26420).
3030

@@ -62,7 +62,7 @@ Update go.mod for submodules to depend on the new release which will happen in t
6262
```
6363
6464
3. Update the [Changelog](./CHANGELOG.md).
65-
- Make sure all relevant changes for this release are included and are in language that non-contributors to the project can understand.
65+
- Make sure all relevant changes for this release are included and are written in language that non-contributors to the project can understand.
6666
To verify this, you can look directly at the commits since the `<last tag>`.
6767
6868
```

VERSIONING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ is designed so the following goals can be achieved.
8383
in either the module path or the import path.
8484
* In addition to public APIs, telemetry produced by stable instrumentation
8585
will remain stable and backwards compatible. This is to avoid breaking
86-
alerts and dashboard.
86+
alerts and dashboards.
8787
* Modules will be used to encapsulate instrumentation, detectors, exporters,
8888
propagators, and any other independent sets of related components.
8989
* Experimental modules still under active development will be versioned at

attribute/encoder.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type (
1616
// set into a wire representation.
1717
Encoder interface {
1818
// Encode returns the serialized encoding of the attribute set using
19-
// its Iterator. This result may be cached by a attribute.Set.
19+
// its Iterator. This result may be cached by an attribute.Set.
2020
Encode(iterator Iterator) string
2121

2222
// ID returns a value that is unique for each class of attribute

bridge/opencensus/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
// - The NewContext method of the OpenCensus Tracer cannot embed an OpenCensus
4141
// Span in a context unless that Span was created by that Tracer.
4242
// - Conversion of custom OpenCensus Samplers to OpenTelemetry is not
43-
// implemented, and An error will be sent to the OpenTelemetry ErrorHandler.
43+
// implemented, and an error will be sent to the OpenTelemetry ErrorHandler.
4444
//
4545
// There are known limitations to the metric bridge:
4646
// - GaugeDistribution-typed metrics are dropped

exporters/stdout/stdoutmetric/encoder.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type Encoder interface {
1515
}
1616

1717
// encoderHolder is the concrete type used to wrap an Encoder so it can be
18-
// used as a atomic.Value type.
18+
// used as an atomic.Value type.
1919
type encoderHolder struct {
2020
encoder Encoder
2121
}

internal/global/meter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ type delegatedInstrument interface {
105105
setDelegate(metric.Meter)
106106
}
107107

108-
// instID are the identifying properties of a instrument.
108+
// instID are the identifying properties of an instrument.
109109
type instID struct {
110110
// name is the name of the stream.
111111
name string

metric.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
// Meter returns a Meter from the global MeterProvider. The name must be the
1212
// name of the library providing instrumentation. This name may be the same as
1313
// the instrumented code only if that code provides built-in instrumentation.
14-
// If the name is empty, then a implementation defined default name will be
14+
// If the name is empty, then an implementation defined default name will be
1515
// used instead.
1616
//
1717
// If this is called before a global MeterProvider is registered the returned

0 commit comments

Comments
 (0)