Skip to content

Commit

Permalink
Be precise and direct about what we mean by "that usage is deprecated."
Browse files Browse the repository at this point in the history
  • Loading branch information
SyntaxColoring committed Oct 25, 2023
1 parent e4ec541 commit 8e96a4b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion api/src/opentrons/execute.py
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ def execute( # noqa: C901
In older software versions, ``payload["text"]`` was a
`format string <https://docs.python.org/3/library/string.html#formatstrings>`_.
To get human-readable text, you had to do ``payload["text"].format(**payload)``.
That usage is deprecated now. If ``payload["text"]`` happens to contain any
Don't do that anymore. If ``payload["text"]`` happens to contain any
``{`` or ``}`` characters, it can confuse ``.format()`` and cause it to raise a
``KeyError``.
Expand Down
2 changes: 1 addition & 1 deletion api/src/opentrons/simulate.py
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ def simulate(
In older software versions, ``payload["text"]`` was a
`format string <https://docs.python.org/3/library/string.html#formatstrings>`_.
To get human-readable text, you had to do ``payload["text"].format(**payload)``.
That usage is deprecated now. If ``payload["text"]`` happens to contain any
Don't do that anymore. If ``payload["text"]`` happens to contain any
``{`` or ``}`` characters, it can confuse ``.format()`` and cause it to raise a
``KeyError``.
Expand Down

0 comments on commit 8e96a4b

Please sign in to comment.