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

FigureWidget.show() returns a Figure instead of a FigureWidget #4854

Closed
marthacryan opened this issue Nov 7, 2024 · 5 comments · Fixed by #4869
Closed

FigureWidget.show() returns a Figure instead of a FigureWidget #4854

marthacryan opened this issue Nov 7, 2024 · 5 comments · Fixed by #4869
Labels
bug something broken P2 considered for next cycle

Comments

@marthacryan
Copy link
Collaborator

If you run:

fig = go.FigureWidget()
fig.show()

you get a non-interactive figure.
If you run:

fig = go.FigureWidget()
fig

you get an interactive figure widget. This confused me and could lead to people having issues using FigureWidget.

@gvwilson
Copy link
Contributor

@marthacryan should this be changed for 6.0 or left for after?

@gvwilson gvwilson added feature something new P2 considered for next cycle labels Nov 11, 2024
@alexcjohnson
Copy link
Collaborator

Seems to me more like a bug than a feature

@gvwilson gvwilson added bug something broken feature something new and removed feature something new bug something broken labels Nov 11, 2024
@marthacryan
Copy link
Collaborator Author

Seems to me more like a bug than a feature

@alexcjohnson Yes I would say it is likely a bug

@marthacryan
Copy link
Collaborator Author

@marthacryan should this be changed for 6.0 or left for after?

I guess this is technically changing an API, although as Alex said above, I think it's more of a bug than an API. I think it isn't a release blocker but might be slightly better to include in the release? I don't expect this would be very difficult to fix, but I think we might want to give some thought to what behavior we do want in this case. I expected it to be the same as just using the FigureWidget object without .show(), but we could also choose to add a warning / error or point the user to just calling fig instead of fig.show(). @ndrezn any opinions?

@ndrezn
Copy link
Member

ndrezn commented Nov 12, 2024

I agree that it's a bug but IMO it's not a release blocker. I don't think it's worth changing behaviour unless we're applying a fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug something broken P2 considered for next cycle
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants