From 1efa51dbbde276bafbf8266ccf5252d19d9118fa Mon Sep 17 00:00:00 2001 From: Cheng-Lung Sung Date: Thu, 14 Nov 2019 16:00:28 +0800 Subject: [PATCH 1/3] fix typo, wording --- CONTRIBUTING.md | 6 +++--- ext/opentelemetry-ext-wsgi/README.rst | 6 +++--- .../context/propagation/tracecontexthttptextformat.py | 2 +- opentelemetry-api/src/opentelemetry/trace/__init__.py | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74cc345874..e84971fa4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ If you are looking for someone to help you find a starting point and be a resour Gitter and find a buddy! 1. Join [Gitter.im](https://gitter.im) and join our [chat room](https://gitter.im/open-telemetry/opentelemetry-python). -2. Post in the room with an introduction to yourself, what area you are interested in (checks issues marked "Help Wanted"), +2. Post in the room with an introduction to yourself, what area you are interested in (check issues marked "Help Wanted"), and say you are looking for a buddy. We will match you with someone who has experience in that area. Your OpenTelemetry buddy is your resource to talk to directly on all aspects of contributing to OpenTelemetry: providing @@ -37,7 +37,7 @@ You can run: under multiple Python versions - `tox -e docs` to regenerate the API docs - `tox -e test-api` and `tox -e test-sdk` to run the API and SDK unit tests -- `tox -e py37-test-api` to e.g. run the the API unit tests under a specific +- `tox -e py37-test-api` to e.g. run the API unit tests under a specific Python version - `tox -e lint` to run lint checks on all code @@ -115,7 +115,7 @@ It's especially valuable to read through the [library guidelines](https://github OpenTelemetry is an evolving specification, one where the desires and use cases are clear, but the method to satisfy those uses cases are not. -As such, Contributions should provide functionality and behavior that +As such, contributions should provide functionality and behavior that conforms to the specification, but the interface and structure is flexible. It is preferable to have contributions follow the idioms of the language diff --git a/ext/opentelemetry-ext-wsgi/README.rst b/ext/opentelemetry-ext-wsgi/README.rst index e14d2dd05a..82641bcaa4 100644 --- a/ext/opentelemetry-ext-wsgi/README.rst +++ b/ext/opentelemetry-ext-wsgi/README.rst @@ -3,8 +3,8 @@ OpenTelemetry WSGI Middleware |pypi| -.. |pypi| image:: https://badge.fury.io/py/opentelemetry-wsgi.svg - :target: https://pypi.org/project/opentelemetry-opentracing-wsgi/ +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-wsgi.svg + :target: https://pypi.org/project/opentelemetry-ext-wsgi/ This library provides a WSGI middleware that can be used on any WSGI framework @@ -15,7 +15,7 @@ Installation :: - pip install opentelemetry-opentracing-wsgi + pip install opentelemetry-ext-wsgi Usage (Flask) diff --git a/opentelemetry-api/src/opentelemetry/context/propagation/tracecontexthttptextformat.py b/opentelemetry-api/src/opentelemetry/context/propagation/tracecontexthttptextformat.py index 20f2601fa2..5d00632ed1 100644 --- a/opentelemetry-api/src/opentelemetry/context/propagation/tracecontexthttptextformat.py +++ b/opentelemetry-api/src/opentelemetry/context/propagation/tracecontexthttptextformat.py @@ -21,7 +21,7 @@ _T = typing.TypeVar("_T") # Keys and values are strings of up to 256 printable US-ASCII characters. -# Implementations should conform to the the `W3C Trace Context - Tracestate`_ +# Implementations should conform to the `W3C Trace Context - Tracestate`_ # spec, which describes additional restrictions on valid field values. # # .. _W3C Trace Context - Tracestate: diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py index 412a106229..6a9d5b6943 100644 --- a/opentelemetry-api/src/opentelemetry/trace/__init__.py +++ b/opentelemetry-api/src/opentelemetry/trace/__init__.py @@ -285,7 +285,7 @@ class TraceState(typing.Dict[str, str]): """A list of key-value pairs representing vendor-specific trace info. Keys and values are strings of up to 256 printable US-ASCII characters. - Implementations should conform to the the `W3C Trace Context - Tracestate`_ + Implementations should conform to the `W3C Trace Context - Tracestate`_ spec, which describes additional restrictions on valid field values. .. _W3C Trace Context - Tracestate: From d514481ac1464c9f8ef11aa770a4bc19633e34f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mauricio=20V=C3=A1squez?= Date: Thu, 14 Nov 2019 18:05:13 -0500 Subject: [PATCH 2/3] jaeger: fix link to opentelemetry-python repo --- ext/opentelemetry-ext-jaeger/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ext/opentelemetry-ext-jaeger/README.rst b/ext/opentelemetry-ext-jaeger/README.rst index 321e993be1..a03d1b0c1e 100644 --- a/ext/opentelemetry-ext-jaeger/README.rst +++ b/ext/opentelemetry-ext-jaeger/README.rst @@ -26,7 +26,7 @@ gRPC is still not supported by this implementation. .. _Jaeger: https://www.jaegertracing.io/ -.. _OpenTelemetry: https://github.com/opentelemetry/opentelemetry-python/ +.. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/ .. code:: python From bbf9a2c8aa3abcceac8e3e6e3bff9615fa5b574a Mon Sep 17 00:00:00 2001 From: Cheng-Lung Sung Date: Fri, 15 Nov 2019 10:55:05 +0800 Subject: [PATCH 3/3] add "a" --- opentelemetry-api/src/opentelemetry/trace/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py index 6a9d5b6943..74ee0f5dd1 100644 --- a/opentelemetry-api/src/opentelemetry/trace/__init__.py +++ b/opentelemetry-api/src/opentelemetry/trace/__init__.py @@ -135,7 +135,7 @@ class SpanKind(enum.Enum): #: path latency relationship between producer and consumer spans. PRODUCER = 3 - #: Indicates that the span describes consumer receiving a message from a + #: Indicates that the span describes a consumer receiving a message from a #: broker. Unlike client and server, there is usually no direct critical #: path latency relationship between producer and consumer spans. CONSUMER = 4