Skip to content

better docstrings for waitfor methods#88

Merged
rerpha merged 4 commits into
mainfrom
rerpha-patch-1
Jun 16, 2026
Merged

better docstrings for waitfor methods#88
rerpha merged 4 commits into
mainfrom
rerpha-patch-1

Conversation

@rerpha

@rerpha rerpha commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Description of work

spotted these in the training session- updates docstrings with better explained examples.

To test

None

Acceptance criteria

List the acceptance criteria for the PR


Code Review

  • Is the code of an acceptable quality?
  • Are there unit tests in place? Are the unit tests small and test the a class in isolation?
  • Have the changes been documented in the release notes. If so, do they describe the changes appropriately?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed.
  • How do the changes handle unexpected situations, e.g. bad input?
  • Has developer documentation been updated if required?

spotted these in the training session
@rerpha rerpha added documentation Improvements or additions to documentation ignore-for-release labels Jun 16, 2026
@rerpha rerpha moved this to Flash Review in Tasks Jun 16, 2026
@rerpha rerpha added this to Tasks Jun 16, 2026
Comment thread src/genie_python/genie.py Outdated
Co-authored-by: Tom Willemsen <tom.willemsen@stfc.ac.uk>
@rerpha rerpha requested a review from Tom-Willemsen June 16, 2026 16:24
@rerpha rerpha merged commit 799a67a into main Jun 16, 2026
18 checks passed
@rerpha rerpha deleted the rerpha-patch-1 branch June 16, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ignore-for-release

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants