Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling #1515

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you believe you have found a security vulnerability in any Microsoft-owned re

Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).

If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).

You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).

Expand Down
2 changes: 1 addition & 1 deletion azure-pipelines/pipelines.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# This pipeline is used to run PR validation and CI builds against the debugpy public repo.
# Seperate internal pipelines are used for generating wheels, signing, and releasing to pypi.org
# Separate internal pipelines are used for generating wheels, signing, and releasing to pypi.org

# Trigger ci builds for commits into master and any release branches
trigger:
Expand Down
2 changes: 1 addition & 1 deletion src/debugpy/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#
# To fix both, we need to replace the automatically added entry such that it points
# at parent directory of debugpy/ instead of debugpy/ itself, import debugpy with that
# in sys.path, and then remove the first entry entry altogether, so that it doesn't
# in sys.path, and then remove the first entry altogether, so that it doesn't
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an odd duplication, but I think it's just an error.

# affect any further imports we might do. For example, suppose the user did:
#
# python /foo/bar/debugpy ...
Expand Down
2 changes: 1 addition & 1 deletion src/debugpy/adapter/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def _parse_argv(argv):
#
# To fix both, we need to replace the automatically added entry such that it points
# at parent directory of debugpy/ instead of debugpy/adapter, import debugpy with that
# in sys.path, and then remove the first entry entry altogether, so that it doesn't
# in sys.path, and then remove the first entry altogether, so that it doesn't
# affect any further imports we might do. For example, suppose the user did:
#
# python /foo/bar/debugpy/adapter ...
Expand Down
2 changes: 1 addition & 1 deletion src/debugpy/adapter/clients.py
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ def terminate_request(self, request):
self.restart_requested = False

if self._forward_terminate_request:
# According to the spec, terminate should try to do a gracefull shutdown.
# According to the spec, terminate should try to do a graceful shutdown.
# We do this in the server by interrupting the main thread with a Ctrl+C.
# To force the kill a subsequent request would do a disconnect.
#
Expand Down
2 changes: 1 addition & 1 deletion src/debugpy/adapter/components.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ class Capabilities(dict):
"""

PROPERTIES = {}
"""JSON property names and default values for the the capabilities represented
"""JSON property names and default values for the capabilities represented
by instances of this class. Keys are names, and values are either default values
or validators.

Expand Down
2 changes: 1 addition & 1 deletion src/debugpy/adapter/sessions.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def __init__(self):
"""The client component. Always present."""

self.launcher = components.missing(self, launchers.Launcher)
"""The launcher componet. Always present in "launch" sessions, and never
"""The launcher component. Always present in "launch" sessions, and never
present in "attach" sessions.
"""

Expand Down
4 changes: 2 additions & 2 deletions src/debugpy/common/messaging.py
Original file line number Diff line number Diff line change
Expand Up @@ -974,7 +974,7 @@ class MessageHandlingError(Exception):
escape the message loop unhandled, and terminate the process.

If any message handler raises this exception, but applies_to(message) is False, it
is treated as if it was a generic exception, as desribed above. Thus, if a request
is treated as if it was a generic exception, as described above. Thus, if a request
handler issues another request of its own, and that one fails, the failure is not
silently propagated. However, a request that is delegated via Request.delegate()
will also propagate failures back automatically. For manual propagation, catch the
Expand All @@ -995,7 +995,7 @@ def __init__(self, reason, cause=None, silent=False):
"""Creates a new instance of this class, and immediately logs the exception.

Message handling errors are logged immediately unless silent=True, so that the
precise context in which they occured can be determined from the surrounding
precise context in which they occurred can be determined from the surrounding
log entries.
"""

Expand Down
2 changes: 1 addition & 1 deletion src/debugpy/launcher/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def main():
#
# To fix both, we need to replace the automatically added entry such that it points
# at parent directory of debugpy/ instead of debugpy/launcher, import debugpy with that
# in sys.path, and then remove the first entry entry altogether, so that it doesn't
# in sys.path, and then remove the first entry altogether, so that it doesn't
# affect any further imports we might do. For example, suppose the user did:
#
# python /foo/bar/debugpy/launcher ...
Expand Down
4 changes: 2 additions & 2 deletions src/debugpy/public_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def listen(
different from address if port was 0 in the latter, in which case
the adapter will pick some unused ephemeral port to listen on.

This function does't wait for a client to connect to the debug
This function doesn't wait for a client to connect to the debug
adapter that it starts. Use `wait_for_client` to block execution
until the client connects.
"""
Expand All @@ -131,7 +131,7 @@ def connect(__endpoint: Endpoint | int, *, access_token: str | None = None) -> E
`access_token` must be the same value that was passed to the adapter
via the `--server-access-token` command-line switch.

This function does't wait for a client to connect to the debug
This function doesn't wait for a client to connect to the debug
adapter that it connects to. Use `wait_for_client` to block
execution until the client connects.
"""
Expand Down
2 changes: 1 addition & 1 deletion tests/DEBUGGEE_PYTHONPATH/debuggee/backchannel.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# for license information.

"""Imported from test code that runs under debugpy, and allows that code
to communcate back to the test. Works in conjunction with debug_session
to communicate back to the test. Works in conjunction with debug_session
fixture and its backchannel method."""

__all__ = ["port", "receive", "send"]
Expand Down
2 changes: 1 addition & 1 deletion tests/debugpy/common/test_messaging.py
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ def test_str_to_num(self):
for val_trial, type_trial in correct_trials:
assert isinstance(
json.of_type(type_trial)(val_trial), type_trial
), "Wrong type coversion"
), "Wrong type conversion"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unless some test measurement cares...


# test conversion that are not expected to work
try:
Expand Down
4 changes: 2 additions & 2 deletions tests/debugpy/test_completions.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ class SomeClass:
def __init__(self, someVar):
self.some_var = someVar

def do_someting(self):
def do_something(self):
someVariable = self.some_var
return someVariable # @in_do_something

def someFunction(someVar):
someVariable = someVar
return SomeClass(someVariable).do_someting() # @in_some_function
return SomeClass(someVariable).do_something() # @in_some_function

someFunction("value")
print("done") # @done
Expand Down
2 changes: 1 addition & 1 deletion tests/pytest_fixtures.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ def script_file():
that it uses locally. When linter complains, use #noqa.

Returns a py.path.local instance that has the additional attribute "lines".
After the source is writen to disk, tests.code.get_marked_line_numbers() is
After the source is written to disk, tests.code.get_marked_line_numbers() is
invoked on the resulting file to compute the value of that attribute.
"""

Expand Down
8 changes: 4 additions & 4 deletions tests/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ A *timeline* is a sequence of [occurrences](#Occurrence), in order in which they

A timeline can be grown by recording new occurrences in it. This is done automatically by the test infrastructure for requests, responses and events occurring in a debug session. Marks are recorded with the `timeline.mark(id)` method, which returns the recorded mark occurrence. It is not possible to "rewrite the history" - once recorded, occurrences can never be forgotten, and do not change.

Timelines are completely thread-safe for both recording and inspection. However, because a timeline during an active debug session can grow asyncronously as new events and responses are received, it cannot be inspected directly, other than asking for the last occurrence via `timeline.last()` - which is a function rather than a property, indicating that it may return a different value on every subsequent call.
Timelines are completely thread-safe for both recording and inspection. However, because a timeline during an active debug session can grow asynchronously as new events and responses are received, it cannot be inspected directly, other than asking for the last occurrence via `timeline.last()` - which is a function rather than a property, indicating that it may return a different value on every subsequent call.

It is, however, possible to take a snapshot of a timeline via `timeline.history()`; the returned value is a list of all occurrences that were in the timeline at the point of the call, in order from first to last. This is just a shortcut for `reversed(list(timeline.last()))`.

Expand Down Expand Up @@ -112,7 +112,7 @@ and a further shortcut to issue a request, wait for response, and retrieve the r
```py
initialize_response_body = debug_session.request('initialize', {'adapterID': 'test'})
```
On success, `request()` returns the body of the sucessful response directly, rather than the `Response` object. On failure, it raises the appropriate exception.
On success, `request()` returns the body of the successful response directly, rather than the `Response` object. On failure, it raises the appropriate exception.

## Expectation algebra

Expand Down Expand Up @@ -187,7 +187,7 @@ assert (
) in debug_session.timeline
```

### Conjuction (`&`)
### Conjunction (`&`)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these can break incoming links, but hopefully no one cares


When two expectations are conjuncted: `(A & B)` - the resulting expectation is realized at the occurrence at which `A` and `B` are both realized, regardless of their relative order. Thus:
```py
Expand Down Expand Up @@ -244,7 +244,7 @@ if handled_request is pause1:
...
```

### Exclusive disjuction (`^`)
### Exclusive disjunction (`^`)

When two expectations are exclusively disjuncted: `(A ^ B)` - the resulting expectation is realized at the first occurrence at which either `A` or `B` is realized, but not both. Thus, the expectation:
```py
Expand Down
2 changes: 1 addition & 1 deletion versioneer.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
## Known Limitations

Some situations are known to cause problems for Versioneer. This details the
most significant ones. More can be found on Github
most significant ones. More can be found on GitHub
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

brand

[issues page](https://github.com/python-versioneer/python-versioneer/issues).

### Subprojects
Expand Down
Loading