Skip to content

Commit

Permalink
fix: typo recieved -> received (#15112)
Browse files Browse the repository at this point in the history
# Overview

Spotted a typo in an error message and did a sweep across the whole
monorepo to fix it.

Closes RTC-449

# Test Plan

Relying on CI to tell me if I broke anything.

# Changelog

Fixed the typo in these locations:
- Hardcoded nav in OT-One Python docs
- Nav templates in other Python docs
- Several hardware error messages

# Review requests

Did my best to avoid modifying any actual code. Please double check.

# Risk assessment

v low, unless we're depending on exact error strings downstream
somewhere.
  • Loading branch information
ecormany authored May 8, 2024
1 parent 1dede8b commit e2c6417
Show file tree
Hide file tree
Showing 24 changed files with 41 additions and 41 deletions.
2 changes: 1 addition & 1 deletion api/docs/ot1/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@
data-gtm-label="start-guide"
data-gtm-action="click"
>OT-2 Start Guide</a>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/calibration.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/containers.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/firmware.html
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/pipettes.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/robot.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/transfer.html
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/ot1/writing.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/templates/hardware/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/templates/v1/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
2 changes: 1 addition & 1 deletion api/docs/templates/v2/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@
data-gtm-action="click"
>OT-2 Start Guide</a
>
<span>You recieved your robot, here's what's next</span>
<span>You received your robot, here's what's next</span>
</li>
<li onclick="closeMenu()">
<a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ async def set_run_current(
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to set run current for {str(node)}"
f"received error {str(error)} trying to set run current for {str(node)}"
)


Expand All @@ -97,5 +97,5 @@ async def set_hold_current(
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to set run current for {str(node)}"
f"received error {str(error)} trying to set run current for {str(node)}"
)
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ async def set_reference_voltage(
expected_nodes=[NodeId.gripper_g],
)
if error != ErrorCode.ok:
log.error(f"recieved error trying to set gripper vref {str(error)}")
log.error(f"received error trying to set gripper vref {str(error)}")


async def set_pwm_param(
Expand All @@ -80,7 +80,7 @@ async def set_pwm_param(
expected_nodes=[NodeId.gripper_g],
)
if error != ErrorCode.ok:
log.error(f"recieved error trying to set gripper pwm {str(error)}")
log.error(f"received error trying to set gripper pwm {str(error)}")


async def set_error_tolerance(
Expand All @@ -100,7 +100,7 @@ async def set_error_tolerance(
expected_nodes=[NodeId.gripper_g],
)
if error != ErrorCode.ok:
log.error(f"recieved error trying to set gripper error tolerance {str(error)}")
log.error(f"received error trying to set gripper error tolerance {str(error)}")


async def set_jaw_holdoff(
Expand All @@ -119,7 +119,7 @@ async def set_jaw_holdoff(
)
if error != ErrorCode.ok:
log.error(
f"recieved error trying to set gripper jaw holdoff value {str(error)}"
f"received error trying to set gripper jaw holdoff value {str(error)}"
)


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ async def set_hepa_fan_state(
expected_nodes=[NodeId.hepa_uv],
)
if error != ErrorCode.ok:
log.error(f"recieved error trying to set hepa fan state {str(error)}")
log.error(f"received error trying to set hepa fan state {str(error)}")
return error == ErrorCode.ok


Expand Down Expand Up @@ -117,7 +117,7 @@ async def set_hepa_uv_state(
expected_nodes=[NodeId.hepa_uv],
)
if error != ErrorCode.ok:
log.error(f"recieved error trying to set hepa uv light state {str(error)}")
log.error(f"received error trying to set hepa uv light state {str(error)}")
return error == ErrorCode.ok


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def _listener(message: MessageDefinition, arbitration_id: ArbitrationId) -> None
)
return
if message.message_id == MessageId.error_message:
log.error(f"recieved an error {str(message)}")
log.error(f"received an error {str(message)}")
return
elif message.message_id != MessageId.limit_sw_response:
log.warning(f"unexpected message id: 0x{message.message_id:x}")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ async def set_enable_motor(
expected_nodes=[node],
)
if error != ErrorCode.ok:
log.error(f"recieved error {str(error)} trying to enable {str(node)} ")
log.error(f"received error {str(error)} trying to enable {str(node)} ")


async def set_disable_motor(
Expand All @@ -53,7 +53,7 @@ async def set_disable_motor(
expected_nodes=[node],
)
if error != ErrorCode.ok:
log.error(f"recieved error {str(error)} trying to disable {str(node)} ")
log.error(f"received error {str(error)} trying to disable {str(node)} ")


async def set_enable_tip_motor(
Expand All @@ -68,7 +68,7 @@ async def set_enable_tip_motor(
expected_nodes=[node],
)
if error != ErrorCode.ok:
log.error(f"recieved error {str(error)} trying to enable {str(node)} ")
log.error(f"received error {str(error)} trying to enable {str(node)} ")


async def set_disable_tip_motor(
Expand All @@ -83,7 +83,7 @@ async def set_disable_tip_motor(
expected_nodes=[node],
)
if error != ErrorCode.ok:
log.error(f"recieved error {str(error)} trying to disable {str(node)} ")
log.error(f"received error {str(error)} trying to disable {str(node)} ")


async def get_motor_enabled(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ async def _await_one_result(callback: WaitableCallback) -> ToolDetectionResult:
if isinstance(response, message_definitions.PushToolsDetectedNotification):
return _handle_detection_result(response)
if isinstance(response, message_definitions.ErrorMessage):
log.error(f"Recieved error message {str(response)}")
log.error(f"Received error message {str(response)}")
raise CanbusCommunicationError(message="Messenger closed before a tool was found")


Expand Down Expand Up @@ -78,7 +78,7 @@ async def _await_responses(
seen.add(node)
break
elif isinstance(response, message_definitions.ErrorMessage):
log.error(f"Recieved error message {str(response)}")
log.error(f"Received error message {str(response)}")


async def _handle_gripper_info(
Expand Down
18 changes: 9 additions & 9 deletions hardware/opentrons_hardware/sensors/scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ async def send_write(
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to write sensor info to {sensor_info.node_id.name}"
f"received error {str(error)} trying to write sensor info to {sensor_info.node_id.name}"
)

async def send_read(
Expand Down Expand Up @@ -384,7 +384,7 @@ def _log_sensor_output(message: MessageDefinition, arb: ArbitrationId) -> None:
f"{SensorDataType.build(message.payload.sensor_data, message.payload.sensor).to_float()}"
)
if isinstance(message, ErrorMessage):
log.error(f"recieved error message {str(message)}")
log.error(f"received error message {str(message)}")

@asynccontextmanager
async def bind_sync(
Expand All @@ -411,7 +411,7 @@ async def bind_sync(
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to bind sensor output on {str(target_sensor.node_id)}"
f"received error {str(error)} trying to bind sensor output on {str(target_sensor.node_id)}"
)

try:
Expand All @@ -436,7 +436,7 @@ async def bind_sync(
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to write unbind sensor output on {str(target_sensor.node_id)}"
f"received error {str(error)} trying to write unbind sensor output on {str(target_sensor.node_id)}"
)

@asynccontextmanager
Expand All @@ -457,7 +457,7 @@ def _logging_listener(
SensorDataType.build(payload.sensor_data, payload.sensor).to_float()
)
if isinstance(message, ErrorMessage):
log.error(f"Recieved error message {str(message)}")
log.error(f"Received error message {str(message)}")

def _filter(arbitration_id: ArbitrationId) -> bool:
return (
Expand All @@ -483,7 +483,7 @@ def _filter(arbitration_id: ArbitrationId) -> bool:
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to bind sensor output on {str(target_sensor.node_id)}"
f"received error {str(error)} trying to bind sensor output on {str(target_sensor.node_id)}"
)

try:
Expand All @@ -505,7 +505,7 @@ def _filter(arbitration_id: ArbitrationId) -> bool:
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to write unbind sensor output on {str(target_sensor.node_id)}"
f"received error {str(error)} trying to write unbind sensor output on {str(target_sensor.node_id)}"
)

@asynccontextmanager
Expand Down Expand Up @@ -562,7 +562,7 @@ def _filter(arbitration_id: ArbitrationId) -> bool:
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to bind sensor output on {str(sensor.node_id)}"
f"received error {str(error)} trying to bind sensor output on {str(sensor.node_id)}"
)

try:
Expand All @@ -586,5 +586,5 @@ def _filter(arbitration_id: ArbitrationId) -> bool:
)
if error != ErrorCode.ok:
log.error(
f"recieved error {str(error)} trying to write unbind sensor output on {str(sensor.node_id)}"
f"received error {str(error)} trying to write unbind sensor output on {str(sensor.node_id)}"
)

0 comments on commit e2c6417

Please sign in to comment.