Docs: Add docstring to _calibrate method in AnalogInput

[vabhravi]

I noticed the _calibrate method in analog.py was missing a docstring. I added documentation to explain how it calculates slope and intercept for voltage conversion, improving code readability.

Summary by Sourcery

Documentation:

• Add a docstring describing how AnalogInput._calibrate derives scaling coefficients for ADC-to-voltage conversion.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds documentation for the _calibrate method in AnalogInput to clarify how ADC values are converted to voltages; no functional logic changes are introduced.

File-Level Changes

Change	Details	Files
Document how _calibrate computes scaling coefficients for ADC-to-voltage conversion.	Add a descriptive docstring to _calibrate explaining its role in computing slope and intercept based on gain and resolution. Clarify that _scale and _unscale are prepared as linear conversion functions between raw ADC integers and floating-point voltages.	pslab/instrument/analog.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• The docstring for _calibrate could mention that it updates the internal _scale and _unscale callables as a side effect so future readers understand why it doesn’t return anything.
• The whitespace-only change in _range_normalize (removing and re-adding the same return line) is unnecessary and can be dropped to keep the diff minimal.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The docstring for `_calibrate` could mention that it updates the internal `_scale` and `_unscale` callables as a side effect so future readers understand why it doesn’t return anything.
- The whitespace-only change in `_range_normalize` (removing and re-adding the same return line) is unnecessary and can be dropped to keep the diff minimal.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}