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 Spinner API, fix #11004 #11772

Merged
merged 3 commits into from Jun 1, 2021

Conversation

embray
Copy link
Member

@embray embray commented May 21, 2021

Reverts #11771

Re-merge #11046 once we find out what in the name of ... would possibly cause this to cause the RTD builds to hang.

EDIT: Fix #11004

@embray embray added utils Enhancement API change PRs and issues that change an existing API, possibly requiring a deprecation period labels May 21, 2021
@pllim
Copy link
Member

pllim commented May 21, 2021

Forget about reredirect, let's rerevert 😹

@pllim pllim added this to the v5.0 milestone May 21, 2021
@pllim
Copy link
Member

pllim commented May 21, 2021

Well, no need to worry about the change log check failure right now...

@pllim
Copy link
Member

pllim commented May 21, 2021

If my hunch is correct, changing ProgressBarOrSpinner to just ProgressBar in utils/data.py will fix RTD, though even if that is the case, it is not the correct fix.

@bsipocz
Copy link
Member

bsipocz commented May 25, 2021

Please do not open branches in the main repo, but rather in your fork.

@pllim
Copy link
Member

pllim commented May 25, 2021

I think this is a side effect from pressing the "revert" button on GitHub.

@bsipocz
Copy link
Member

bsipocz commented May 25, 2021

Yes, I suppose it's down to GitHub. Yet, in that case stuff like this needs to be merged asap and the branch deleted, or they will show up in forks, too.

You can argue is not a big deal, but as a rule of thumb we should do what we preach about workflow.

@pllim
Copy link
Member

pllim commented May 25, 2021

Yes, understood. If I get lucky over at #11779 , I might move the fix over there and close this, though I am unable to promise a fast turnaround. Sorry for any inconvenience caused!

@embray
Copy link
Member Author

embray commented May 26, 2021

I don't really see the problem. I guess in the case of the GitHub "Revert" button it's an exception to the normal rule. It's too bad it doesn't give an option to make the branch in a fork, like the online file editor does. But it's not "preaching" anything.

@embray
Copy link
Member Author

embray commented May 26, 2021

Can confirm that the way Spinner.update() behaves makes no sense, now that I look at this again. If you pass it a large value it will just sit there spinning forever.

the value argument should be ignored.

Also delete unnecessary self._obj.__enter__ line in
ProgressBarOrSpinner.__enter__, since it's a no-op for the two types of
objects wrapped by ProgressBarOrSpinner.
@embray
Copy link
Member Author

embray commented May 26, 2021

Should we keep the existing towncrier file or move it to the new PR number?

@pllim
Copy link
Member

pllim commented May 26, 2021

Oh, good! I am glad you fixed it. I was dabbling on the doc side and was sliding into a rabbit hole.

Should we keep the existing towncrier file or move it to the new PR number?

I dunno. I will never grok this towncrier stuff. @saimn or @Cadair , what is your advise here?

@pllim
Copy link
Member

pllim commented May 26, 2021

p.s. Since the original PR was flawed anyway, maybe just change the PR number to match this one?

Copy link
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Since the CI passed, I am approving, with the expectation that y'all will sort out the change log stuff. Thanks!

@saimn
Copy link
Contributor

saimn commented May 26, 2021

I'm a bit lost by the revert of revert, but it seems this PR is the one fixing the bug so I guess the PR number should be updated in the fragment filename ?

@bsipocz
Copy link
Member

bsipocz commented May 26, 2021

I don't really see the problem. I guess in the case of the GitHub "Revert" button it's an exception to the normal rule. It's too bad it doesn't give an option to make the branch in a fork, like the online file editor does. But it's not "preaching" anything.

But this is not a simple revert, but a revert of a revert with some additional changes. So it would have been nicer to make readd that PR along with the fixes in a separate feature PR. (I also have strong opinions of any reverts should be done from a feature branch rather than in the main repo, after all the revert commit can be added locally. I know it's an easy feature of github, but we also doesn't use other features it offers as they don't fit into the workflow, and the revert should be part of that collection).

@embray
Copy link
Member Author

embray commented May 31, 2021

Yeah, I think I made a mess by making a revert of a revert. Should have just introduced a new PR.

Perhaps we should add something in the developer docs against using GitHub's built-in revert feature?

@embray embray changed the title Revert "Revert "Updating spinner API, keeping enum"" Update Spinner API, fix #11004 May 31, 2021
@embray
Copy link
Member Author

embray commented May 31, 2021

I'll change the PR number for the changelog entry.

@embray embray added this to To do in Software Operations Support Specialist via automation May 31, 2021
@pllim
Copy link
Member

pllim commented Jun 1, 2021

Re: developer docs -- I am neutral on this. We don't revert very often.

Copy link
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Thanks!

@pllim pllim merged commit 505c02d into main Jun 1, 2021
@pllim pllim deleted the revert-11771-revert-11046-update_spinner_keep_enum branch June 1, 2021 18:48
@pllim pllim moved this from To do to Done in Software Operations Support Specialist Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API change PRs and issues that change an existing API, possibly requiring a deprecation period Enhancement utils
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Outdated documentation for Spinner
4 participants