Skip to content

Commit

Permalink
Remove references to SSCOM port name
Browse files Browse the repository at this point in the history
  • Loading branch information
kmontag committed May 13, 2024
1 parent fdc5e04 commit 7b935e0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ that source won't show up until tests are actually running, so you'll
need to configure the control surface manually while you're running
tests for the first time.

You can add the test control surface in addition to the main SSCOM
control surface, if you don't want to deal with switching the
You can safely add this test control surface alongside your primary
modeStep control surface, if you don't want to deal with switching the
input/output when you want to run tests.

To run tests, use:
Expand All @@ -25,13 +25,19 @@ For debug output:
DEBUG=1 make test
```

To run only specs tagged with `@now`:

```shell
.venv/bin/pytest -m now
```

## Linting and type checks

Before submitting a PR, make sure the following are passing:

```shell
make lint # Validates code style
make check # Validates types
make lint # Validates code style.
make check # Validates types.
```

Some lint errors can be fixed automatically with:
Expand Down
5 changes: 3 additions & 2 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -404,10 +404,11 @@ def ioport():
yield ioport


# Relay port to the physical device for visual feedback during tests, if available.
# Cheap thrills - relay the test port to the physical device for visual feedback during
# tests, if available.
@fixture
def relay_port() -> Generator[Optional[mido.ports.BaseOutput], Never, None]:
port_name = "SSCOM Port 1"
port_name = "SoftStep Control Surface"
try:
with mido.open_output(port_name) as relay_port: # type: ignore
yield relay_port
Expand Down

0 comments on commit 7b935e0

Please sign in to comment.