Skip to content

Rename hamilton trough 60mL and 200mL to use correct SI casing#947

Merged
BioCam merged 3 commits intoPyLabRobot:mainfrom
BioCam:Correct-hamilton_1_trough_60ml_Vb-naming
Mar 20, 2026
Merged

Rename hamilton trough 60mL and 200mL to use correct SI casing#947
BioCam merged 3 commits intoPyLabRobot:mainfrom
BioCam:Correct-hamilton_1_trough_60ml_Vb-naming

Conversation

@BioCam
Copy link
Collaborator

@BioCam BioCam commented Mar 19, 2026

Summary

  • Rename hamilton_1_trough_60ml_Vbhamilton_1_trough_60mL_Vb
  • Rename hamilton_1_trough_200ml_Vbhamilton_1_trough_200mL_Vb
  • Fix hamilton_1_trough_120mL_Vb warning string that still said 120ml
  • Add deprecated aliases for old names with DeprecationWarning (remove after 2026-07)
  • Update Hamilton_1_trough_200ml_Vb alias to forward to new name (remove after 2026-07)
  • Update docs and trough carrier docstrings

Test plan

  • from pylabrobot.resources.hamilton.troughs import hamilton_1_trough_60mL_Vb works
  • from pylabrobot.resources.hamilton.troughs import hamilton_1_trough_200mL_Vb works
  • Old names emit DeprecationWarning and still return correct Trough
  • python -W all -c "from pylabrobot.resources.hamilton.troughs import hamilton_1_trough_60ml_Vb" shows warning

🤖 Generated with Claude Code

BioCam and others added 2 commits March 19, 2026 23:10
…nd fix 120mL warning typo

- Rename function and data variable to use correct SI `mL` casing
- Add deprecated `hamilton_1_trough_200ml_Vb` alias (remove 2026-07)
- Update existing `Hamilton_1_trough_200ml_Vb` alias to forward to new name (remove 2026-07)
- Fix warning string in `hamilton_1_trough_120mL_Vb` that still said `120ml`
- Update docs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Comment on lines +180 to +182
warnings.warn(
"hamilton_1_trough_200ml_Vb() is deprecated and will be removed after 2026-07. "
"Use hamilton_1_trough_200mL_Vb() instead.",
Copy link
Member

Choose a reason for hiding this comment

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

dates are arbitrary now that we have versions. let's say "removed in v1"

Copy link
Collaborator Author

@BioCam BioCam Mar 20, 2026

Choose a reason for hiding this comment

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

mhmmm... this is now the development branch and since we don't have regular version releases scheduled yet people would have no idea when v1 will be - leaving them stranded, not knowing whether they would have 1 day or 4 months to update

I suggest we keep both: at least 4 month transition periods in the development branch - giving users that are dependent on the dev branch clear dates to prepare for - and specified version announcements which summarise all updates, with an emphasis on the breaking changes?

The development branch should still continue Pragmatic Programming Rule #1 "Do No Harm".
And the versioning seems still in active development with the public not knowing yet how PLR will implement it and communicate it.

@BioCam BioCam merged commit 1d1b586 into PyLabRobot:main Mar 20, 2026
21 checks passed
@BioCam BioCam deleted the Correct-hamilton_1_trough_60ml_Vb-naming branch March 20, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants