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

fixed typos and closed open brackets (#807) #1126

Merged
merged 3 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/event_sequence.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ callbacks.

`PhaseGroup` collections behave like contexts. They are entered if their
`setup` phases are all non-terminal; if this happens, the `teardown` phases are
guarenteed to run. `PhaseGroup` collections can contain additional `PhaseGroup`
guaranteed to run. `PhaseGroup` collections can contain additional `PhaseGroup`
instances. If a nested group has a terminal phase, the outer groups will trigger
the same shortcut logic.

Expand Down
2 changes: 1 addition & 1 deletion examples/phase_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"""Example OpenHTF Phase Groups.
PhaseGroups are used to control phase shortcutting due to terminal errors to
better guarentee when teardown phases run.
better guarantee when teardown phases run.
"""

import openhtf as htf
Expand Down
2 changes: 1 addition & 1 deletion openhtf/core/diagnoses_lib.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ def example_phase(test, reader):
def block_test_diag(test_record, diagnoses_store):
if (diagnoses_store.has_diagnosis_result(
BlockStatusResult.BLOCK0_OUT_OF_SPEC) and
diagnoses_store.has_diganosis_result(
diagnoses_store.has_diagnosis_result(
BlockStatusResult.BLOCK1_OUT_OF_SPEC)):
return openhtf.Diagnosis(
BlockStatusResult.UNIT_OUT_OF_SPEC,
Expand Down
2 changes: 1 addition & 1 deletion openhtf/core/phase_branches.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def _not_all(iterable: Iterator[bool]) -> bool:

@attr.s(slots=True, frozen=True)
class DiagnosisCondition(object):
"""Encapsulated object for evaulating DiagResultEnum conditions."""
"""Encapsulated object for evaluating DiagResultEnum conditions."""

# Indicates the diagnosis is tested.
condition = attr.ib(type=ConditionOn)
Expand Down
4 changes: 2 additions & 2 deletions openhtf/core/test_record.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
CONF.declare(
'attachments_directory',
default_value=None,
description='Directory where temprorary files can be safely stored.')
description='Directory where temporary files can be safely stored.')

_LOG = logging.getLogger(__name__)

Expand Down Expand Up @@ -339,7 +339,7 @@ class PhaseRecord(object):
dictionaries, each of which map measurement name to the respective object. In
the case of the measurements field, those objects are measurements.Measurement
instances. The 'value' attribute of each of those instances is an instance of
measurments.MeasuredValue, which contains either a single value, or a list of
measurements.MeasuredValue, which contains either a single value, or a list of
values in the case of a dimensioned measurement.
See measurements.Record.GetValues() for more information.
Expand Down
2 changes: 1 addition & 1 deletion openhtf/core/test_state.py
Original file line number Diff line number Diff line change
Expand Up @@ -866,7 +866,7 @@ def _execute_phase_diagnoser(
if self.phase_record.result.is_terminal:
self.logger.exception(
'Phase Diagnoser %s raised an exception, but phase result is '
'already terminal; logging additonal exception here.',
'already terminal; logging additional exception here.',
diagnoser.name)
else:
self.phase_record.result = phase_executor.PhaseExecutionOutcome(
Expand Down
2 changes: 1 addition & 1 deletion openhtf/output/callbacks/json_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def stream_json(
json_encoder = TestRecordEncoder(allow_nan=allow_nan, **kwargs)

# The iterencode return type in typeshed for PY2 is wrong; not worried about
# fixing it as we are droping PY2 support soon.
# fixing it as we are dropping PY2 support soon.
return json_encoder.iterencode(encoded_test_rec) # pytype: disable=bad-return-type


Expand Down
10 changes: 5 additions & 5 deletions openhtf/output/callbacks/mfg_inspector.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,18 @@ class MfgInspector(object):
my_custom_converter)
my_tester.add_output_callbacks(interface.save_to_disk(), interface.upload())

**Important** the conversion of the TestRecord to protofbuf as specified in
**Important** the conversion of the TestRecord to protobuf as specified in
the _converter callable attribute only occurs once and the resulting protobuf
is cached in memory on the instance.

The upload callback will upload to mfg-inspector.com using the given
username and authentication key (which should be the key data itself, not a
filename or file).

In typical productin setups, we *first* save the protobuf to disk then attempt
to upload the protobuf to mfg-inspector. In the event of a network outage,
the result of the test run is available on disk and a separate process can
retry the upload when network is available.
In typical production setups, we *first* save the protobuf to disk then
attempt to upload the protobuf to mfg-inspector. In the event of a network,
outage the result of the test run is available on disk and a separate process
can retry the upload when the network is available.
"""

TOKEN_URI = 'https://accounts.google.com/o/oauth2/token'
Expand Down
2 changes: 1 addition & 1 deletion openhtf/output/proto/assembly_event.proto
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ message AssemblyEvent {
// An individual Component, potentially a member of an assembly.
message Component {
string part_number = 1; // GPN
// Unique idenfier of a component, either serial or lot/index.
// Unique identifier of a component, either serial or lot/index.
oneof id {
string serial = 2; // GSN. Most components will have this.
ByLot lot = 3; // For tracking resistors, lenses, etc.
Expand Down
2 changes: 1 addition & 1 deletion openhtf/output/proto/mfg_event.proto
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ message MfgEvent {
// The serial number or lot info of the device under test.
// For non-serialized items, we can track them via lot_number and an
// optional lot_index within the lot (such as "This tray of items is lot
// #FOT123 and this is the part in slot 6 of the tray.
// #FOT123 and this is the part in slot 6 of the tray.)s
message ByLot {
required string lot_number = 1;
optional string lot_index = 2;
Expand Down
4 changes: 2 additions & 2 deletions openhtf/output/proto/test_runs.proto
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ message Phase {
optional TimeInfo timing = 4;
}

// A parameter which is tested during a test run. These are parameteric values
// A parameter which is tested during a test run. These are parametric values
// which are used to pass or fail the test.
message TestParameter {
// reserved 9;
Expand Down Expand Up @@ -223,7 +223,7 @@ message TestRun {
// Not supported by OpenHTF.
// For non-serialized items, we can track them via lot_number and a part_id
// within the lot (such as "This try of items is lot #FOT123 and this is the
// part in slot 6 of the tray. In this case, a unique dut should be
// part in slot 6 of the tray). In this case, a unique dut should be
// synthesized and stored in the required field dut_serial, and the
// synthetic_dut flag should be set.
optional string lot_number = 23;
Expand Down