From cd2583df6a2c1f8eac9c0fe4bfbfd1ddff5aaa39 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 21 Mar 2022 23:12:40 -0700 Subject: [PATCH] Add misspell check (and fix misspellings) (#4290) * Add misspell check * Fix misspellings * Spotless --- .github/workflows/main-build.yml | 11 +++++++++ .github/workflows/pr-build.yml | 11 +++++++++ .../api/metrics/LongGaugeBuilder.java | 2 +- .../internal/shaded/WeakConcurrentMap.java | 2 +- .../aws/resource/SimpleHttpClient.java | 2 +- .../extension/zpages/IndexZPageHandler.java | 2 +- .../zpages/TraceConfigzZPageHandler.java | 6 ++--- .../extension/zpages/TracezZPageHandler.java | 4 ++-- sdk/metrics/README.md | 2 +- .../internal/data/ImmutableMetricData.java | 24 +++++++++---------- 10 files changed, 44 insertions(+), 22 deletions(-) diff --git a/.github/workflows/main-build.yml b/.github/workflows/main-build.yml index 96cf7fdbf4..5910418e4c 100644 --- a/.github/workflows/main-build.yml +++ b/.github/workflows/main-build.yml @@ -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' }} diff --git a/.github/workflows/pr-build.yml b/.github/workflows/pr-build.yml index 36fd9770ec..716d6a4ec3 100644 --- a/.github/workflows/pr-build.yml +++ b/.github/workflows/pr-build.yml @@ -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 ./**/* diff --git a/api/all/src/main/java/io/opentelemetry/api/metrics/LongGaugeBuilder.java b/api/all/src/main/java/io/opentelemetry/api/metrics/LongGaugeBuilder.java index dfae6b480a..3154840bdc 100644 --- a/api/all/src/main/java/io/opentelemetry/api/metrics/LongGaugeBuilder.java +++ b/api/all/src/main/java/io/opentelemetry/api/metrics/LongGaugeBuilder.java @@ -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. * *

The callback will only be called when the {@link Meter} is being observed. * diff --git a/context/src/main/java/io/opentelemetry/context/internal/shaded/WeakConcurrentMap.java b/context/src/main/java/io/opentelemetry/context/internal/shaded/WeakConcurrentMap.java index dce63e7d6c..de6502d879 100644 --- a/context/src/main/java/io/opentelemetry/context/internal/shaded/WeakConcurrentMap.java +++ b/context/src/main/java/io/opentelemetry/context/internal/shaded/WeakConcurrentMap.java @@ -94,7 +94,7 @@ public class WeakConcurrentMap 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; } diff --git a/sdk-extensions/aws/src/main/java/io/opentelemetry/sdk/extension/aws/resource/SimpleHttpClient.java b/sdk-extensions/aws/src/main/java/io/opentelemetry/sdk/extension/aws/resource/SimpleHttpClient.java index dc43f037ff..85f29001ef 100644 --- a/sdk-extensions/aws/src/main/java/io/opentelemetry/sdk/extension/aws/resource/SimpleHttpClient.java +++ b/sdk-extensions/aws/src/main/java/io/opentelemetry/sdk/extension/aws/resource/SimpleHttpClient.java @@ -73,7 +73,7 @@ final class SimpleHttpClient { if (responseCode != 200) { logger.log( Level.FINE, - "Error reponse from " + "Error response from " + urlStr + " code (" + responseCode diff --git a/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/IndexZPageHandler.java b/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/IndexZPageHandler.java index 0d29692ee8..9469c96ee2 100644 --- a/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/IndexZPageHandler.java +++ b/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/IndexZPageHandler.java @@ -47,7 +47,7 @@ final class IndexZPageHandler extends ZPageHandler { @Override public void emitHtml(Map 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(""); out.print(""); diff --git a/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TraceConfigzZPageHandler.java b/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TraceConfigzZPageHandler.java index 631e0d61ff..b86f202f21 100644 --- a/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TraceConfigzZPageHandler.java +++ b/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TraceConfigzZPageHandler.java @@ -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 tag. + * Emits CSS styles to the {@link PrintStream} {@code out}. Content emitted by this function + * should be enclosed by tag. * * @param out the {@link PrintStream} {@code out}. */ @@ -277,7 +277,7 @@ final class TraceConfigzZPageHandler extends ZPageHandler { @Override public void emitHtml(Map 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(""); out.print(""); diff --git a/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TracezZPageHandler.java b/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TracezZPageHandler.java index 5865194458..bdb1c5f6c9 100644 --- a/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TracezZPageHandler.java +++ b/sdk-extensions/zpages/src/main/java/io/opentelemetry/sdk/extension/zpages/TracezZPageHandler.java @@ -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 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(""); out.print(""); diff --git a/sdk/metrics/README.md b/sdk/metrics/README.md index b1dcb6b206..a6ae1c45d4 100644 --- a/sdk/metrics/README.md +++ b/sdk/metrics/README.md @@ -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: diff --git a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/data/ImmutableMetricData.java b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/data/ImmutableMetricData.java index e057955fe1..070673180c 100644 --- a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/data/ImmutableMetricData.java +++ b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/data/ImmutableMetricData.java @@ -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,