Skip to content

docs: fix MultiMixEnv docstring referencing step instead of reset#759

Open
william-xue wants to merge 1 commit into
Grid2op:masterfrom
william-xue:docs/fix-multimix-reset-description
Open

docs: fix MultiMixEnv docstring referencing step instead of reset#759
william-xue wants to merge 1 commit into
Grid2op:masterfrom
william-xue:docs/fix-multimix-reset-description

Conversation

@william-xue
Copy link
Copy Markdown

Summary

The MultiMixEnv class docstring incorrectly states that a different mix is used each time the step function is called. In practice, the mix rotates on reset, not step — each step call continues within the same mix until the episode ends and reset is called again.

This one-word fix corrects the docstring from "step" to "reset" to match the actual behavior.

Test plan

  • Verify the MultiMixEnv class docstring now says "reset" instead of "step"
  • Confirm the behavior matches: calling reset() cycles to the next mix, while step() stays in the current mix

Fixes #734

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
@sonarqubecloud
Copy link
Copy Markdown

@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

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.

@BDonnot
Copy link
Copy Markdown
Collaborator

BDonnot commented May 29, 2026

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 branch

If 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:

You are the only author of the commits in this branch
You are absolutely certain nobody else is doing any work based upon this branch
There are no empty commits in the branch (for example, a DCO Remediation Commit which was added using --allow-empty)

To add your Signed-off-by line to every commit in this branch:

Ensure you have a local copy of your branch by [checking out the pull request locally via command line](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally).
In your local branch, run: git rebase HEAD~1 --signoff
Force push your changes to overwrite the branch: git push --force-with-lease origin docs/fix-multimix-reset-description

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.

MultiMixEnv docs mistake

2 participants