docs: fix MultiMixEnv docstring referencing step instead of reset#759
docs: fix MultiMixEnv docstring referencing step instead of reset#759william-xue wants to merge 1 commit into
Conversation
The MultiMixEnv class docstring incorrectly states that a different mix is used each time the 'step' function is called. In practice, the mix changes on 'reset', not 'step'. Fixes Grid2op#734
|
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
|
Hello, You need to signoff the commit in order to make contribution. This is rather easy in this case, as you are the only author of the PR. The DCO bot gives you what you need to do: Rebase the branchIf you have a local git environment and meet the criteria below, one option is to rebase the branch and add your Signed-off-by lines in the new commits. Please note that if others have already begun work based upon the commits in this branch, this solution will rewrite history and may cause serious issues for collaborators (described in the git documentation under "The Perils of Rebasing"). You should only do this if: To add your Signed-off-by line to every commit in this branch: |



Summary
The
MultiMixEnvclass docstring incorrectly states that a different mix is used each time thestepfunction is called. In practice, the mix rotates onreset, notstep— eachstepcall continues within the same mix until the episode ends andresetis called again.This one-word fix corrects the docstring from "step" to "reset" to match the actual behavior.
Test plan
MultiMixEnvclass docstring now says "reset" instead of "step"reset()cycles to the next mix, whilestep()stays in the current mixFixes #734