Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves documentation for the AbstractTestManager class by enhancing docstrings with clearer descriptions, parameter documentation, and return value specifications. It also renames episode_i to current_episode_number for better clarity and converts the get_n_episodes() method to a property n_episodes.
Changes:
- Renamed
episode_itocurrent_episode_numberfor improved naming clarity - Enhanced docstrings for
reset_field(),eval_status(), andn_episodeswith detailed descriptions and return value documentation - Converted
get_n_episodes()method to a property decoratorn_episodes - Added visual markers to indicate which methods need to be implemented by subclasses
energy-in-joles
added
release:minor
fred-huang122
previously approved these changes
Jan 15, 2026
Collaborator
fred-huang122
left a comment
fred-huang122
left a comment
There was a problem hiding this comment.
Looks good, just a question there
| ### Specify in subclass ### | ||
| n_episodes: int # number of episodes for the test | ||
| ############################## | ||
|
|
Collaborator
There was a problem hiding this comment.
What does the comment above mean? Can you explain? @energy-in-joles
Member
Author
There was a problem hiding this comment.
just trying to box the area that needs to be edited. Let me make it clearer
fred-huang122
approved these changes
Jan 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Simplify
n_episodesproperty and clearer variable name fromself.episode_itoself.current_episode_number. Also improve documentation.Linked with Utama-Strategy PR14. (https://github.com/First-Order-RoboCup-SSL/Utama-Strategy/pull/14)