Skip to content

explain that 'stack' barmode also works for px.bar #1987

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

Open
wants to merge 5 commits into
base: doc-prod
Choose a base branch
from

Conversation

Ddedalus
Copy link

@Ddedalus Ddedalus commented Dec 9, 2019

Hi, this is my first pull request, if I choose the wrong branch, please let me know :)

Just a small extension to the available options of px.bar to begin with.

@Ddedalus Ddedalus changed the title 'stack' barmode also works for px.bar Doc: 'stack' barmode also works for px.bar Dec 9, 2019
@nicolaskruchten
Copy link
Contributor

Thanks for this PR! I had initially left out "stack" because it's so easy to misunderstand what it does with respect to negative values... We probably should indeed add it but with a clear warning about how unintuitive the output can be.

@Ddedalus
Copy link
Author

I've tried it out on a small example and added a brief note. If you think more explanation is needed there (or my understanding is wrong), please go ahead. It may be a good idea to put a longer description in go.Bar docs as well...

Out of curiosity, how would you create a stack plot where positive and negative values are stacked separately on the opposite sides of the x-axis?

@emmanuelle
Copy link
Contributor

Thanks for updating the PR @Ddedalus ! @nicolaskruchten I think we can merge this one?

Review change

Co-Authored-By: Emmanuelle Gouillart <[email protected]>
@nicolaskruchten
Copy link
Contributor

nicolaskruchten commented Jan 25, 2020

Right, so to stack above and below zero the option is “relative”. The “stack” option is supported but needs a clear and scary warning like “this is almost never what you want to use and will often mislead viewers when negative values are involved” or something like that. We have to support it for backwards compatibility reasons but IMO it’s quite a dangerous option.

@gvwilson gvwilson requested review from emmanuelle, emilykl and marthacryan and removed request for emmanuelle July 19, 2024 14:55
@gvwilson gvwilson assigned gvwilson and LiamConnors and unassigned gvwilson Jul 19, 2024
@gvwilson gvwilson changed the title Doc: 'stack' barmode also works for px.bar explain that 'stack' barmode also works for px.bar Aug 12, 2024
@gvwilson gvwilson added feature something new P3 backlog documentation written for humans labels Aug 12, 2024
@marthacryan marthacryan removed the feature something new label Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation written for humans P3 backlog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants