docs(api): Update reference docs for ProtocolContext.pause()

[SyntaxColoring]

Changelog

ProtocolContext.pause() has confusing (RESC-165, RESC-201) behavior on Python Protocol API version 2.13 and below. This was documented, but we didn't document that it's fixed in Protocol API v2.14. Do that here.

Review requests

None in particular.

Risk assessment

No risk.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bcd312d) 67.78% compared to head (c4a8045) 67.78%.
Report is 3 commits behind head on edge.

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #14500      +/-   ##
==========================================
- Coverage   67.78%   67.78%   -0.01%     
==========================================
  Files        2517     2517              
  Lines       72044    72043       -1     
  Branches     9274     9274              
==========================================
- Hits        48838    48837       -1     
  Misses      20991    20991              
  Partials     2215     2215              

Flag	Coverage Δ
app	64.64% <ø> (ø)
components	48.90% <ø> (ø)
g-code-testing	92.43% <ø> (ø)
labware-library	41.11% <ø> (ø)
protocol-designer	37.93% <ø> (ø)
react-api-client	66.38% <ø> (ø)
step-generation	86.90% <ø> (ø)

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

Files	Coverage Δ
api/src/opentrons/protocol_api/protocol_context.py	92.74% <ø> (-0.06%)	⬇️

[ecormany]

Thanks for clarifying this. Part of me wants for this to be a .. versionchanged message, but I think a proper explanation would be too long in that format. So the .. note is better.

[jwwojak]

👍 to Ed's comment. Otherwise, LGTM.