You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
### Focus on Capabilities, Not Structure Compliance
167
166
168
167
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
170
169
not.
171
170
172
171
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
174
173
flexible.
175
174
176
175
It is preferable to have contributions follow the idioms of the
@@ -217,7 +216,7 @@ about dependency compatibility.
217
216
This project does not partition dependencies based on the environment (i.e.
218
217
`development`, `staging`, `production`).
219
218
220
-
Only the dependencies explicitly included in the released modules have be
219
+
Only the dependencies explicitly included in the released modules have been
221
220
tested and verified to work with the released code. No other guarantee is made
222
221
about the compatibility of other dependencies.
223
222
@@ -635,8 +634,8 @@ is not in their root name.
635
634
636
635
The use of internal packages should be scoped to a single module. A sub-module
637
636
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].
640
639
641
640
There are two known exceptions to this rule:
642
641
@@ -657,7 +656,7 @@ this.
657
656
658
657
### Ignoring context cancellation
659
658
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
661
660
passed when recording a value (e.g. starting a span, recording a measurement, emitting a log).
662
661
Recording methods should not return an error describing the cancellation state of the context
663
662
when they complete, nor should they abort any work.
@@ -891,7 +890,7 @@ func (i *instrumentation) record(ctx context.Context, value int64, baseAttrs ...
891
890
892
891
Pools are most effective when there are many pooled objects of the same sufficiently large size, and the objects are repeatedly used.
893
892
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.
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.
1083
1082
See [stdouttrace exporter example](./exporters/stdout/stdouttrace/internal/gen.go) for reference.
Copy file name to clipboardExpand all lines: RELEASING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Ensure things look correct before submitting a pull request to include the addit
24
24
25
25
## Breaking changes validation
26
26
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.
28
28
29
29
You can check/report problems with `gorelease`[here](https://golang.org/issues/26420).
30
30
@@ -62,7 +62,7 @@ Update go.mod for submodules to depend on the new release which will happen in t
62
62
```
63
63
64
64
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.
66
66
To verify this, you can look directly at the commits since the `<last tag>`.
0 commit comments