Skip to content

Conversation

dwhswenson
Copy link
Member

@dwhswenson dwhswenson commented Oct 29, 2021

This PR will address the need for pauses in the wizard. Currently, the wizard hops from one step to the next very quickly; a brief pause (and possibly some visual cues) will improve UX by making it easier to track what is happening.

This addresses one of the targets for before v0.3 raised in #57:

  • Add pauses at various points to give better UX
    • creating subvolumes
    • after naming an object

Tasks

  • Write basic pausing module, which can be reused (and which allows customization of delays)
  • Tests for pausing module
  • Add pause before creating subvolumes
  • Add pause after each object is created
  • Fix unit tests so that 'nopause' pause style is used in test suite

@dwhswenson dwhswenson marked this pull request as draft October 29, 2021 15:10
@dwhswenson dwhswenson added the enhancement New feature or request label Oct 29, 2021
@codecov
Copy link

codecov bot commented Oct 29, 2021

Codecov Report

Merging #62 (61b8da4) into main (34cf3a0) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##              main       #62   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           51        52    +1     
  Lines         2143      2181   +38     
=========================================
+ Hits          2143      2181   +38     
Impacted Files Coverage Δ
paths_cli/wizard/pause.py 100.00% <100.00%> (ø)
paths_cli/wizard/two_state_tps.py 100.00% <100.00%> (ø)
paths_cli/wizard/volumes.py 100.00% <100.00%> (ø)
paths_cli/wizard/wizard.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 34cf3a0...61b8da4. Read the comment docs.

@dwhswenson dwhswenson mentioned this pull request Oct 29, 2021
18 tasks
@dwhswenson dwhswenson marked this pull request as ready for review November 1, 2021 17:12
@dwhswenson dwhswenson changed the title [WIP] Wizard pauses Wizard pauses Nov 1, 2021
@dwhswenson
Copy link
Member Author

This is ready for review and comment. I will leave it open for at least 24 hours, merging no earlier than Tue 02 Nov 18:00 GMT (14:00 my local).

I think this is an improvement over the previous UX, but I'm very much open to other UX improvements along these lines.

Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 question about the use of global, otherwise LGTM

Co-authored-by: Sander Roet <sanderroet@hotmail.com>
@dwhswenson dwhswenson merged commit 68fc7de into openpathsampling:main Nov 2, 2021
@dwhswenson dwhswenson deleted the wizard-pauses branch November 2, 2021 19:27
@dwhswenson dwhswenson mentioned this pull request Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants