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

docs(api): edit docstring for configure_nozzle_layout #13997

Merged
merged 12 commits into from
Dec 7, 2023

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Nov 16, 2023

Overview

Update the docstring for configure_nozzle_layout, first added in #13838. Goals for this PR:

  • Clearly explain the function's parameters.
  • Only explain layouts that will be supported at the release of PAPI v2.16.
    • Column and full-plate layouts for 96-channel.
    • No partial layouts for 8-channel.
  • Remove code sample from API Reference. A later PR will add multiple code samples and explanation on the Pipettes page of the docs.

Test Plan

Reference entry in sandbox

Changelog

  • Fix RST formatting
  • Edit docstring prose
  • Temporarily remove explanation of front_right parameter
  • Remove code snippet from reference
  • Couple typo fixes in related/nearby core docstrings

Review requests

  • Make sure I've characterized features properly. I haven't been able to simulate protocols using this function yet, much less test them on hardware.

  • Fact check this claim: If you try to perform partial tip pickup on a tip rack that is in an adapter, the API will raise an error.

  • Check that I didn't mess anything up when rebasing and resolving conflicts.

Risk assessment

low, docstrings + a comment hanging off the bottom of the docstring (can't comment within the string)

@ecormany ecormany added docs DO NOT MERGE Indicates a PR should not be merged, even if there's a shiny green merge button available papi-v2 Python API V2 labels Nov 16, 2023
Copy link

codecov bot commented Nov 16, 2023

Codecov Report

Merging #13997 (5a59278) into chore_release-7.1.0 (9860f20) will not change coverage.
Report is 6 commits behind head on chore_release-7.1.0.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@                 Coverage Diff                  @@
##           chore_release-7.1.0   #13997   +/-   ##
====================================================
  Coverage                70.46%   70.46%           
====================================================
  Files                     2512     2512           
  Lines                    71202    71202           
  Branches                  8965     8965           
====================================================
  Hits                     50169    50169           
  Misses                   18841    18841           
  Partials                  2192     2192           
Flag Coverage Δ
g-code-testing 96.44% <ø> (ø)
notify-server 89.13% <ø> (ø)

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

Files Coverage Δ
...i/src/opentrons/protocol_api/instrument_context.py 89.40% <ø> (ø)

@ecormany ecormany removed the DO NOT MERGE Indicates a PR should not be merged, even if there's a shiny green merge button available label Nov 29, 2023
@ecormany ecormany marked this pull request as ready for review December 6, 2023 15:58
@ecormany ecormany requested a review from a team as a code owner December 6, 2023 15:58
@ecormany ecormany changed the base branch from edge to chore_release-7.1.0 December 6, 2023 15:59
Copy link
Member

@sfoster1 sfoster1 left a comment

Choose a reason for hiding this comment

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

Very good catch, thank you!

@sfoster1
Copy link
Member

sfoster1 commented Dec 6, 2023

Fact check is correct, description is correct, merge conflicts are now fixed

Copy link
Contributor

@Laura-Danielle Laura-Danielle left a comment

Choose a reason for hiding this comment

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

Few small comments but overall looks good to me!

api/src/opentrons/protocol_api/instrument_context.py Outdated Show resolved Hide resolved
``"A1"`` to have the pipette use its leftmost nozzles to pick up tips
*left-to-right* from a tip rack. Use ``"A12"`` to have the pipette use its
rightmost nozzles to pick up tips *right-to-left* from a tip rack.
:type start: str or ``None``
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we're missing the tip_racks parameter in this list? Unless the diff is being weird.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh yeah, because it just got merged an hour ago! 😅 I will get the stub that @sanni-t wrote back in, and follow up with her on anything more we want to say about it or the new active_channels property.

@ecormany ecormany merged commit 28ede47 into chore_release-7.1.0 Dec 7, 2023
25 checks passed
@ecormany ecormany deleted the docstring-configure_nozzle_layout branch December 7, 2023 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs papi-v2 Python API V2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants