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): Absorbance Plate Reader in Python API docs #16668

Merged
merged 17 commits into from
Nov 18, 2024

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Nov 1, 2024

Overview

Adds a docs page and publishes API Reference entries for the Absorbance Plate Reader.

Addresses RTC-488, RTC-508.

Test Plan and Hands on Testing

Sandbox

Changelog

  • Adds a new page, Absorbance Plate Reader Module, under Hardware Modules
  • Links to new page from Hardware Modules landing page
  • Adds Absorbance Plate Reader to Module Setup page
  • Adds H3s for modules in API Reference for easier navigation
  • Edits to AbsorbanceReaderContext docstrings in module_contexts.py
  • Cleaned up malformed note syntax for Thermocycler in module_contexts.py
  • Removed nitpick rule from conf.py now that AbsorbanceReaderContext is published
  • 🆕 Instruct authors not to detect CSV dialect when using plate reader output as RTP.

Review requests

  • Check that all descriptions are true to how the plate reader behaves.
  • Double check that my code simulates — I have done this once.
  • Do we need more information in any area, especially for CSV files?
    • Should we provide a sample? If so, where to put it?
    • ✅ Should we give more concrete guidance on parsing the CSV other than "you know how to write code, yeah"?
  • 🆕 Do we need to list the four wavelengths values that actually function on a default HW config?

Risk assessment

v low, docs only

@ecormany ecormany added docs papi-v2 Python API V2 labels Nov 1, 2024
@ecormany ecormany changed the title docs(api): Absorbance Plate Reader in API reference docs(api): Absorbance Plate Reader in Python API docs Nov 7, 2024
Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.43%. Comparing base (ec7641c) to head (bc50c82).
Report is 25 commits behind head on chore_release-8.2.0.

Additional details and impacted files

Impacted file tree graph

@@                 Coverage Diff                  @@
##           chore_release-8.2.0   #16668   +/-   ##
====================================================
  Coverage                92.43%   92.43%           
====================================================
  Files                       77       77           
  Lines                     1283     1283           
====================================================
  Hits                      1186     1186           
  Misses                      97       97           
Flag Coverage Δ
g-code-testing 92.43% <ø> (ø)

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

@ecormany ecormany marked this pull request as ready for review November 8, 2024 22:48
@ecormany ecormany requested a review from a team as a code owner November 8, 2024 22:48
Copy link
Contributor

@CaseyBatten CaseyBatten left a comment

Choose a reason for hiding this comment

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

Looks really great, all the information regarding plate reader setup and use appears to be accurate to me.

api/docs/v2/modules/absorbance_plate_reader.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@jwwojak jwwojak left a comment

Choose a reason for hiding this comment

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

Added review comments for consideration.

api/docs/v2/modules/absorbance_plate_reader.rst Outdated Show resolved Hide resolved
api/docs/v2/modules/absorbance_plate_reader.rst Outdated Show resolved Hide resolved
api/docs/v2/modules/absorbance_plate_reader.rst Outdated Show resolved Hide resolved
api/docs/v2/modules/absorbance_plate_reader.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@emilyburghardt emilyburghardt left a comment

Choose a reason for hiding this comment

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

I really like this; I think it's descriptive of the methods to use the plate reader and that users will appreciate the ways to use the data afterwards.

Added a few comments that are mostly clarifications based on questions that jumped into my (newbie) head while reading.

api/docs/v2/modules/absorbance_plate_reader.rst Outdated Show resolved Hide resolved
@ecormany ecormany merged commit 91bab8c into chore_release-8.2.0 Nov 18, 2024
21 checks passed
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.

4 participants