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

refactor(protocol-engine): Shorten error docstrings #12230

Merged
merged 2 commits into from
Mar 6, 2023

Conversation

SyntaxColoring
Copy link
Contributor

Use fewer words in exception docstrings, to give us more space to describe things that are more semantically important.

@SyntaxColoring SyntaxColoring requested a review from a team as a code owner March 3, 2023 22:02
@SyntaxColoring SyntaxColoring requested a review from a team March 3, 2023 22:02
@SyntaxColoring SyntaxColoring added refactor protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs labels Mar 3, 2023
@codecov
Copy link

codecov bot commented Mar 3, 2023

Codecov Report

Merging #12230 (bf05554) into edge (ce1ea36) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #12230   +/-   ##
=======================================
  Coverage   74.01%   74.01%           
=======================================
  Files        2193     2193           
  Lines       60360    60360           
  Branches     6223     6223           
=======================================
  Hits        44676    44676           
  Misses      14254    14254           
  Partials     1430     1430           
Flag Coverage Δ
notify-server 89.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...src/opentrons/protocol_engine/errors/exceptions.py 100.00% <ø> (ø)

Copy link
Contributor

@ecormany ecormany left a comment

Choose a reason for hiding this comment

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

🪂 Saw the magic word "docstrings" and dropped in to make some comments. The across-the-board changes look good and these are just some "while we're at it we might as well" suggestions.

api/src/opentrons/protocol_engine/errors/exceptions.py Outdated Show resolved Hide resolved
api/src/opentrons/protocol_engine/errors/exceptions.py Outdated Show resolved Hide resolved
api/src/opentrons/protocol_engine/errors/exceptions.py Outdated Show resolved Hide resolved
Co-authored-by: Ed Cormany <[email protected]>
@SyntaxColoring SyntaxColoring merged commit 710c8fe into edge Mar 6, 2023
@SyntaxColoring SyntaxColoring deleted the shorten_pe_error_docstrings branch March 6, 2023 18:11
y3rsh added a commit that referenced this pull request Mar 6, 2023
* edge:
  refactor(protocol-engine): Shorten error docstrings (#12230)
  chore(app): update electron-builder version from v24 alpha to v24 (#12233)
  chore(app): add new icons for ODD hi-fi (#12231)
  docs: more release docs (#12226)
  fix(app, odd): check isOnDevice true instead of if it is null (#12228)
  docs: remove references to make bump in releasing (#12222)
  refactor(app): scroll to current split from jump to tick, qol tweaks to run preview (#12218)
  fix(app): rewire cli and jupyter snippets to offsets modals  (#12180)
  feat(app): handle non-deterministic protocols (#12173)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants