Skip to content

Conversation

@SudheerKovvuru
Copy link

Type of changes

  • Bug fix
  • New feature
  • Documentation / docstrings
  • Tests
  • Other

AI?

  • AI was used to generate this PR

AI generated PRs may be accepted, but only if @willmcgugan has responded on an issue or discussion.

Checklist

  • I've run the latest black with default args on new code.
  • I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate (see note about typos above).
  • I've added tests for new code.
  • I accept that @willmcgugan may be pedantic in the code review.

Description

This PR fixes a docstring inconsistency in Progress.reset() regarding the
visible parameter.

The docstring previously stated that visible defaults to True, but the
actual behavior preserves the existing visibility unless visible is
explicitly provided.

This change updates the documentation to reflect the current and intended
behavior without modifying runtime logic.

Fixes #3834

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.

[BUG] Docstring mismatch: reset(..., visible=None) says "Defaults to True"

2 participants