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.

Sign up for GitHub

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

Jump to bottom

APIv2 Docs #4120

Closed
wants to merge 19 commits into from
Closed

APIv2 Docs #4120

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
c83217c
"APIv2 Docs:" [opentrons/apiv2index.rst]
wheresaddie Sep 23, 2019
ccbb4ea
"APIv2 Docs:" [opentrons/new_advanced_running.rst]
wheresaddie Sep 24, 2019
084417f
Update new_advanced_running.rst
wheresaddie Sep 24, 2019
6dd514b
"APIv2 Docs:" [opentrons/new_complex_commands.rst]
wheresaddie Sep 25, 2019
754bdc2
"APIv2 Docs:" [opentrons/new_examples.rst]
wheresaddie Sep 25, 2019
3ee18da
"APIv2 Docs:" [opentrons/new_labware.rst]
wheresaddie Sep 25, 2019
22a3fd6
"APIv2 Docs:" [opentrons/new_modules.rst]
wheresaddie Sep 25, 2019
a397916
"APIv2 Docs:" [opentrons/new_pipette.rst]
wheresaddie Sep 27, 2019
eea361a
"APIv2 Docs:" [opentrons/new_protocol_api.rst]
wheresaddie Sep 27, 2019
f85601d
Update api/docs/source/v2/new_pipette.rst
wheresaddie Sep 28, 2019
b541dc0
Update api/docs/source/v2/new_advanced_running.rst
wheresaddie Sep 28, 2019
fe30f8e
Update api/docs/source/v2/apiv2index.rst
wheresaddie Sep 28, 2019
7591734
Update api/docs/source/v2/apiv2index.rst
wheresaddie Sep 28, 2019
89458dd
Update api/docs/source/v2/apiv2index.rst
wheresaddie Sep 28, 2019
30e6fd5
Update api/docs/source/v2/new_labware.rst
wheresaddie Sep 28, 2019
7a928ac
Update api/docs/source/v2/new_modules.rst
wheresaddie Sep 28, 2019
a053d6f
Update api/docs/source/v2/new_modules.rst
wheresaddie Sep 28, 2019
e5a500e
Update api/docs/source/v2/new_pipette.rst
wheresaddie Sep 28, 2019
b90a87e
Update api/docs/source/v2/new_advanced_running.rst
wheresaddie Oct 3, 2019
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
Prev Previous commit
Next Next commit
Update api/docs/source/v2/apiv2index.rst 
Co-Authored-By: Seth Foster <[email protected]>
  • Loading branch information
@wheresaddie @sfoster1
wheresaddie and sfoster1 committed Sep 28, 2019
commit fe30f8eb143410f9a698dadbdf300ef490c2c2d1
2 changes: 1 addition & 1 deletion api/docs/source/v2/apiv2index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Opentrons API version 2 protocols are structured around a function called ``run(
def run(protocol: protocol_api.ProtocolContext):
pass

The function must be named exactly ``run`` and must take exactly one mandatory argument (we recommend ``protocol`` since this argument represents the protocol that the robot will execute and is easy to parse if another editor needs to impliment or resuse your code).
The function must be named exactly ``run`` and must take exactly one mandatory argument (we recommend ``protocol`` since this argument represents the protocol that the robot will execute and is easy to parse if another editor needs to implement or reuse your code).

The function ``run`` is the container for the code that defines your protocol. Protocols are similar to interfaces, in that they define a collection of methods an object must support.

Expand Down