Skip to content

Commit

Permalink
Fix various mis-spellings in code/docs (#708)
Browse files Browse the repository at this point in the history
  • Loading branch information
kianmeng authored Dec 23, 2021
1 parent 2d413f8 commit c71bd8d
Show file tree
Hide file tree
Showing 12 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ The Timeboard and Screenboard API resources are deprecated in favor of the new D
* [BUGFIX] Dogshell: Submit `--date_happened` timestamp when posting events, [#287][], [#301][] (thanks [@gplasky][])
* [FEATURE] API: Add [search](https://docs.datadoghq.com/api/?lang=python#monitors-search) and [groups search](https://docs.datadoghq.com/api/?lang=python#monitors-group-search) methods to the `Monitor` resource, [#299][]
* [IMPROVEMENT] Dogshell: Set API and APP keys with environment variables, [#228][] (thanks [@taraslayshchuk][])
* [IMPROVEMENT] DogStatsD: Prevent an issue that was causing the `timed` context manager object from overwritting a method with an instance variable, [#263][] (thanks [@florean][])
* [IMPROVEMENT] DogStatsD: Prevent an issue that was causing the `timed` context manager object from overwriting a method with an instance variable, [#263][] (thanks [@florean][])
* [OTHER] Include tests in PyPI tarball, [#259][] (thanks [@dotlambda][])

# 0.22.0 / 2018-06-27
Expand Down Expand Up @@ -261,7 +261,7 @@ See [#242][] (thanks [@nilabhsagar][]) for more details.

# 0.18.0 / 2018-01-24
* [BUGFIX] Dogshell: Service checks can be sent with optional parameters set to null values, [#241][] (thanks [@timvisher][])
* [BUGFIX] Dogwrap: Respect the ouput channel encoding format, [#236][] (thanks [@martin308][])
* [BUGFIX] Dogwrap: Respect the output channel encoding format, [#236][] (thanks [@martin308][])
* [FEATURE] DogstatsD: Add beta support for sending global distribution metrics, [#249][]

# 0.17.0 / 2017-11-06
Expand Down
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ This project contains:
- [Threadstats](/datadog/threadstats)


We have [unit](/tests/unit), [integration](/tests/integration) and [performance](/tests/performamce) tests.
We have [unit](/tests/unit), [integration](/tests/integration) and [performance](/tests/performance) tests.
Integration tests need an _API_ and _APP Keys_ to run against a Datadog account.
- __WARNING__: Never use keys for an organization that contains anything important.

Expand Down Expand Up @@ -161,7 +161,7 @@ tox -e integration
###### Admin integration tests

Admin integration tests are tests that either need admin privileges to run (e.g. manage users) or can destructive changes to your org (e.g. muting/unmuting of all monitors).
They are not run by default when invoking `tox`, you have to run them explicitely with:
They are not run by default when invoking `tox`, you have to run them explicitly with:
```
tox -e integration-admin
```
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ After the client is created, you can start sending custom metrics to Datadog. Se
* [Submit a TIMER metric](https://docs.datadoghq.com/metrics/dogstatsd_metrics_submission/?code-lang=python#timer)
* [Submit a DISTRIBUTION metric](https://docs.datadoghq.com/metrics/dogstatsd_metrics_submission/?code-lang=python#distribution)
Some options are suppported when submitting metrics, like [applying a Sample Rate to your metrics](https://docs.datadoghq.com/metrics/dogstatsd_metrics_submission/?code-lang=python#metric-submission-options) or [tagging your metrics with your custom tags](https://docs.datadoghq.com/metrics/dogstatsd_metrics_submission/?code-lang=python#metric-tagging).
Some options are supported when submitting metrics, like [applying a Sample Rate to your metrics](https://docs.datadoghq.com/metrics/dogstatsd_metrics_submission/?code-lang=python#metric-submission-options) or [tagging your metrics with your custom tags](https://docs.datadoghq.com/metrics/dogstatsd_metrics_submission/?code-lang=python#metric-tagging).
#### Events
Expand Down
2 changes: 1 addition & 1 deletion datadog/api/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def submit(
:param params: dictionary to be sent in the query string of the request
:type params: dictionary
:returns: JSON or formated response from HTTP API request
:returns: JSON or formatted response from HTTP API request
"""
try:
# Check if it's ok to submit
Expand Down
2 changes: 1 addition & 1 deletion datadog/api/http_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ def request(cls, method, url, headers, params, data, timeout, proxies, verify, m
except TypeError:
raise TypeError(
u"Your installed version of `requests` library seems not compatible with"
u"Datadog's usage. We recommand upgrading it ('pip install -U requests')."
u"Datadog's usage. We recommend upgrading it ('pip install -U requests')."
u"If you need help or have any question, please contact [email protected]"
)

Expand Down
2 changes: 1 addition & 1 deletion datadog/api/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def query(cls, **params):
cls._resource_name = cls._METRIC_QUERY_ENDPOINT

# `from` is a reserved keyword in Python, therefore
# `api.Metric.query(from=...)` is not permited
# `api.Metric.query(from=...)` is not permitted
# -> map `start` to `from` and `end` to `to`
try:
params["from"] = params.pop("start")
Expand Down
2 changes: 1 addition & 1 deletion datadog/api/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def invite(cls, emails):
*emails* list. If *emails* is a string, it will be wrapped in a list and
sent. Returns a list of email addresses for which an email was sent.
:param emails: emails adresses to invite to join datadog
:param emails: emails addresses to invite to join datadog
:type emails: string list
:returns: Dictionary representing the API's JSON response
Expand Down
2 changes: 1 addition & 1 deletion datadog/dogstatsd/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -793,7 +793,7 @@ def _xmit_packet(self, packet, is_telemetry):

return True
except socket.timeout:
# dogstatsd is overflowing, drop the packets (mimicks the UDP behaviour)
# dogstatsd is overflowing, drop the packets (mimics the UDP behaviour)
pass
except (socket.herror, socket.gaierror) as socket_err:
log.warning(
Expand Down
4 changes: 2 additions & 2 deletions datadog/threadstats/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def set(self, metric_name, value, timestamp=None, tags=None, sample_rate=1, host
flushed as a gauge to Datadog. Optionally, specify a set of
tags to associate with the metric.
>>> stats.set("example_metric.set", "value_1", tags=["environement:dev"])
>>> stats.set("example_metric.set", "value_1", tags=["environment:dev"])
"""
if not self._disabled:
self._metric_aggregator.add_point(
Expand Down Expand Up @@ -270,7 +270,7 @@ def decrement(self, metric_name, value=1, timestamp=None, tags=None, sample_rate
def histogram(self, metric_name, value, timestamp=None, tags=None, sample_rate=1, host=None):
"""
Sample a histogram value. Histograms will produce metrics that
describe the distribution of the recorded values, namely the maximum, mininum,
describe the distribution of the recorded values, namely the maximum, minimum,
average, count and the 75/85/95/99 percentiles. Optionally, specify
a list of ``tags`` to associate with the metric.
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/api/helper.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def tearDown(self):

def load_request_response(self, status_code=200, response_body='{}', raise_for_status=False):
"""
Load the repsonse body from the given payload
Load the response body from the given payload
"""
mock_response = MockResponse(raise_for_status=raise_for_status)
if is_p3k():
Expand Down
4 changes: 2 additions & 2 deletions tests/unit/api/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -771,7 +771,7 @@ def test_compression(self):
headers = kwargs["headers"]
assert "Content-Encoding" not in headers
assert req_data == json.dumps({"series": [series]})
# Same result when explicitely False
# Same result when explicitly False
Metric.send(compress_payload=False, attach_host_name=False, **series)
_, kwargs = self.request_mock.call_args()
req_data = kwargs["data"]
Expand All @@ -786,7 +786,7 @@ def test_compression(self):
headers = kwargs["headers"]
assert "Content-Encoding" not in headers
assert req_data == json.dumps({"series": [series]})
# Same result when explicitely False
# Same result when explicitly False
Distribution.send(compress_payload=False, attach_host_name=False, **series)
_, kwargs = self.request_mock.call_args()
req_data = kwargs["data"]
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/dogstatsd/test_statsd.py
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ def test_metric_namespace(self):
self.statsd.gauge('gauge', 123.4)
self.assert_equal_telemetry('foo.gauge:123.4|g\n', self.recv(2))

# Test Client level contant tags
# Test Client level content tags
def test_gauge_constant_tags(self):
self.statsd.constant_tags = ['bar:baz', 'foo']
self.statsd.gauge('gauge', 123.4)
Expand Down

0 comments on commit c71bd8d

Please sign in to comment.