open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add misspell check (and fix misspellings) (#4290) 

* Add misspell check

* Fix misspellings

* Spotless
This commit is contained in:
Trask Stalnaker 2022-03-21 23:12:40 -07:00 committed by GitHub
parent 559d05adf5
commit cd2583df6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 44 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.github/workflows/main-build.yml vendored
View File

@ -94,6 +94,17 @@ jobs:
-print0 \
| xargs -0 -n1 markdown-link-check --config .github/scripts/markdown_link_check_config.json
markdown-misspell-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check markdown for common misspellings
run: |
curl -L -o ./install-misspell.sh https://git.io/misspell
sh ./install-misspell.sh
./bin/misspell -error ./**/*
publish-snapshots:
name: Publish snapshots
if: ${{ github.event_name == 'push' && github.repository == 'open-telemetry/opentelemetry-java' }}

11
.github/workflows/pr-build.yml vendored
View File

@ -67,3 +67,14 @@ jobs:
with:
name: coverage-report
path: all/build/reports/jacoco/test/html
markdown-misspell-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check markdown for common misspellings
run: |
curl -L -o ./install-misspell.sh https://git.io/misspell
sh ./install-misspell.sh
./bin/misspell -error ./**/*

2
api/all/src/main/java/io/opentelemetry/api/metrics/LongGaugeBuilder.java
View File

@ -26,7 +26,7 @@ public interface LongGaugeBuilder {
LongGaugeBuilder setUnit(String unit);
/**
* Builds this asynchronous insturment with the given callback.
* Builds this asynchronous instrument with the given callback.
*
* <p>The callback will only be called when the {@link Meter} is being observed.
*

2
context/src/main/java/io/opentelemetry/context/internal/shaded/WeakConcurrentMap.java
View File

@ -94,7 +94,7 @@ public class WeakConcurrentMap<K, V>
return classLoader == null // bootstrap class loader
|| classLoader == ClassLoader.getSystemClassLoader()
|| classLoader
== ClassLoader.getSystemClassLoader().getParent(); // ext/platfrom class loader;
== ClassLoader.getSystemClassLoader().getParent(); // ext/platform class loader;
} catch (Throwable ignored) {
return false;
}

2
sdk-extensions/aws/src/main/java/io/opentelemetry/sdk/extension/aws/resource/SimpleHttpClient.java
View File

@ -73,7 +73,7 @@ final class SimpleHttpClient {
if (responseCode != 200) {
logger.log(
Level.FINE,
"Error reponse from "
"Error response from "
+ urlStr
+ " code ("
+ responseCode

2
sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/IndexZPageHandler.java
View File

@ -47,7 +47,7 @@ final class IndexZPageHandler extends ZPageHandler {
@Override
public void emitHtml(Map<String, String> queryMap, OutputStream outputStream) {
// PrintStream for emiting HTML contents
// PrintStream for emitting HTML contents
try (PrintStream out = new PrintStream(outputStream, /* autoFlush= */ false, "UTF-8")) {
out.print("<!DOCTYPE html>");
out.print("<html lang=\"en\">");

6
sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TraceConfigzZPageHandler.java
View File

@ -56,8 +56,8 @@ final class TraceConfigzZPageHandler extends ZPageHandler {
}
/**
* Emits CSS styles to the {@link PrintStream} {@code out}. Content emited by this function should
* be enclosed by <head></head> tag.
* Emits CSS styles to the {@link PrintStream} {@code out}. Content emitted by this function
* should be enclosed by <head></head> tag.
*
* @param out the {@link PrintStream} {@code out}.
*/
@ -277,7 +277,7 @@ final class TraceConfigzZPageHandler extends ZPageHandler {
@Override
public void emitHtml(Map<String, String> queryMap, OutputStream outputStream) {
// PrintStream for emiting HTML contents
// PrintStream for emitting HTML contents
try (PrintStream out = new PrintStream(outputStream, /* autoFlush= */ false, "UTF-8")) {
out.print("<!DOCTYPE html>");
out.print("<html lang=\"en\">");

4
sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TracezZPageHandler.java
View File

@ -153,7 +153,7 @@ final class TracezZPageHandler extends ZPageHandler {
}
/**
* Emits a single cell of the summary table depends on the paramters passed in, to the {@link
* Emits a single cell of the summary table depends on the parameters passed in, to the {@link
* PrintStream} {@code out}.
*
* @param out the {@link PrintStream} {@code out}.
@ -492,7 +492,7 @@ final class TracezZPageHandler extends ZPageHandler {
@Override
public void emitHtml(Map<String, String> queryMap, OutputStream outputStream) {
// PrintStream for emiting HTML contents
// PrintStream for emitting HTML contents
try (PrintStream out = new PrintStream(outputStream, /* autoFlush= */ false, "UTF-8")) {
out.print("<!DOCTYPE html>");
out.print("<html lang=\"en\">");

2
sdk/metrics/README.md
View File

@ -2,7 +2,7 @@
[![Javadocs][javadoc-image]][javadoc-url]
The code in this directory is currently the legacy impelmentation of the previous experimental metrics SDK specification.
The code in this directory is currently the legacy implementation of the previous experimental metrics SDK specification.
The following set of known issues will be fixed aas the new SDK specification stabilizes:

24
sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/data/ImmutableMetricData.java
View File

@ -31,9 +31,9 @@ import javax.annotation.concurrent.Immutable;
public abstract class ImmutableMetricData implements MetricData {
/**
* Returns a new MetricData wih a {@link MetricDataType#DOUBLE_GAUGE} type.
* Returns a new MetricData with a {@link MetricDataType#DOUBLE_GAUGE} type.
*
* @return a new MetricData wih a {@link MetricDataType#DOUBLE_GAUGE} type.
* @return a new MetricData with a {@link MetricDataType#DOUBLE_GAUGE} type.
*/
public static MetricData createDoubleGauge(
Resource resource,
@ -53,9 +53,9 @@ public abstract class ImmutableMetricData implements MetricData {
}
/**
* Returns a new MetricData wih a {@link MetricDataType#LONG_GAUGE} type.
* Returns a new MetricData with a {@link MetricDataType#LONG_GAUGE} type.
*
* @return a new MetricData wih a {@link MetricDataType#LONG_GAUGE} type.
* @return a new MetricData with a {@link MetricDataType#LONG_GAUGE} type.
*/
public static MetricData createLongGauge(
Resource resource,
@ -75,9 +75,9 @@ public abstract class ImmutableMetricData implements MetricData {
}
/**
* Returns a new MetricData wih a {@link MetricDataType#DOUBLE_SUM} type.
* Returns a new MetricData with a {@link MetricDataType#DOUBLE_SUM} type.
*
* @return a new MetricData wih a {@link MetricDataType#DOUBLE_SUM} type.
* @return a new MetricData with a {@link MetricDataType#DOUBLE_SUM} type.
*/
public static MetricData createDoubleSum(
Resource resource,
@ -97,9 +97,9 @@ public abstract class ImmutableMetricData implements MetricData {
}
/**
* Returns a new MetricData wih a {@link MetricDataType#LONG_SUM} type.
* Returns a new MetricData with a {@link MetricDataType#LONG_SUM} type.
*
* @return a new MetricData wih a {@link MetricDataType#LONG_SUM} type.
* @return a new MetricData with a {@link MetricDataType#LONG_SUM} type.
*/
public static MetricData createLongSum(
Resource resource,
@ -113,9 +113,9 @@ public abstract class ImmutableMetricData implements MetricData {
}
/**
* Returns a new MetricData wih a {@link MetricDataType#SUMMARY} type.
* Returns a new MetricData with a {@link MetricDataType#SUMMARY} type.
*
* @return a new MetricData wih a {@link MetricDataType#SUMMARY} type.
* @return a new MetricData with a {@link MetricDataType#SUMMARY} type.
*/
public static MetricData createDoubleSummary(
Resource resource,
@ -131,7 +131,7 @@ public abstract class ImmutableMetricData implements MetricData {
/**
* Returns a new MetricData with a {@link MetricDataType#HISTOGRAM} type.
*
* @return a new MetricData wih a {@link MetricDataType#HISTOGRAM} type.
* @return a new MetricData with a {@link MetricDataType#HISTOGRAM} type.
*/
public static MetricData createDoubleHistogram(
Resource resource,
@ -153,7 +153,7 @@ public abstract class ImmutableMetricData implements MetricData {
/**
* Returns a new MetricData with a {@link MetricDataType#EXPONENTIAL_HISTOGRAM} type.
*
* @return a new MetricData wih a {@link MetricDataType#EXPONENTIAL_HISTOGRAM} type.
* @return a new MetricData with a {@link MetricDataType#EXPONENTIAL_HISTOGRAM} type.
*/
public static MetricData createExponentialHistogram(
Resource resource,