Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update progress.rst #3242

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

vikasharma005
Copy link

@vikasharma005 vikasharma005 commented Dec 31, 2023

Type of changes

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

Checklist

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

Here is the pull request description formatted in Markdown:

Description

This PR improves the documentation around usage of the start() method in the Progress class.

The changes include:

  • Calling out in Basic Usage that start() is required before updating
To initialize the Progress renderer, you must call `start()` before updating:

progress = Progress()
progress.start()
  • Adding examples both with and without a context manager
# Without context manager

progress = Progress()
progress.start()

# With context manager

with Progress() as progress:
  # no need to call start() 
  • Adding Troubleshooting section mentioning start() for no output
If you are not seeing any output from Progress, ensure you called `start()` on the instance before updating.
  • Raising a warning in __init__ if start() not called

  • Updating FAQ with relevant question

This is intended to address #3240 and improve the documentation based on user feedback in #2758

Usage of start() was not clearly documented before, which led to confusion when the display did not update. These updates should clarify the requirement and guide users to call start().

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.

None yet

1 participant