Skip to content

Commit

Permalink
docs(api): hide API reference entries for post-2.20 features (#16304)
Browse files Browse the repository at this point in the history
# Overview

🤫 Hides 2.21 features from the 2.20 docs.

## Test Plan and Hands on Testing


[Sandbox](http://sandbox.docs.opentrons.com/docs-hide-post-2.20-ref-entries/v2/new_protocol_api.html)

Things you shouldn't see:
- `RobotContext` stuff
- Future liquid level stuff

## Changelog

- `:meta private:` tags for `ProtocolContext.robot` and `Well.meniscus`
- Bumped the required version for `ProtocolContext.robot` because it's
not useful in 2.20.

## Review requests

OK with the version change? It will still be 2.20 in the release branch.
I can revert that line if we prefer.

## Risk assessment

v low
  • Loading branch information
ecormany committed Sep 26, 2024
1 parent 1dc23fb commit e1c8460
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 2 additions & 0 deletions api/src/opentrons/protocol_api/labware.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,8 @@ def meniscus(self, z: float = 0.0) -> Location:
:return: A :py:class:`~opentrons.types.Location` corresponding to the
absolute position of the meniscus-center of the well, plus the ``z`` offset
(if specified).
:meta private:
"""
return Location(self._core.get_meniscus(z_offset=z), self)

Expand Down
6 changes: 5 additions & 1 deletion api/src/opentrons/protocol_api/protocol_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,12 @@ def api_version(self) -> APIVersion:
return self._api_version

@property
@requires_version(2, 20)
@requires_version(2, 21)
def robot(self) -> RobotContext:
"""The :py:class:`.RobotContext` for the protocol.
:meta private:
"""
return self._robot

@property
Expand Down

0 comments on commit e1c8460

Please sign in to comment.