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

Patch 7 #2297

Merged
merged 2 commits into from
Mar 26, 2020
Merged

Patch 7 #2297

merged 2 commits into from
Mar 26, 2020

Conversation

SylwiaOliwia2
Copy link
Contributor

Bolded phrases and additional explanations in the "method" section. The previous version can be misleading to non-heavy users.

  • I've seen the doc/README.md file
  • This change runs in the current version of Plotly on PyPI and targets the doc-prod branch OR it targets the master branch
  • If this PR modifies the first example in a page or adds a new one, it is a px example if at all possible
  • Every new/modified example has a descriptive title and motivating sentence or paragraph
  • Every new/modified example is independently runnable
  • Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized
  • Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
  • The random seed is set if using randomly-generated data in new/modified examples
  • New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
  • Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
  • Imports are plotly.graph_objects as go / plotly.express as px / plotly.io as pio
  • Data frames are always called df
  • fig = <something> call is high up in each new/modified example (either px.<something> or make_subplots or go.Figure)
  • Liberal use is made of fig.add_* and fig.update_* rather than go.Figure(data=..., layout=...) in every new/modified example
  • Specific adders and updaters like fig.add_shape and fig.update_xaxes are used instead of big fig.update_layout calls in every new/modified example
  • fig.show() is at the end of each new/modified example
  • plotly.plot() and plotly.iplot() are not used in any new/modified example
  • Hex codes for colors are not used in any new/modified example in favour of these nice ones

@nicolaskruchten nicolaskruchten changed the base branch from master to doc-prod March 20, 2020 12:29
@nicolaskruchten
Copy link
Contributor

Thank you so much for all these PRs to our documentation! The CI failures you're seeing here can either be ignored for this PR or removed by rebasing onto doc-prod now :)

@SylwiaOliwia2
Copy link
Contributor Author

@nicolaskruchten thank you. I think I managed to rebase it (my first rebase). If not - feel free to correct me :)
Should I create another pull request?

@nicolaskruchten
Copy link
Contributor

OK so it looks like your rebase worked but not on top of the latest changes. You can try something like:

git checkout doc-prod
git pull
git checkout patch-7
git rebase doc-prod
git push -f

I suspect your local copy of doc-prod does not include the commit which fixes the CI, so the first two lines will be needed to fix that first and then the rebase should proceed normally.

Let me know if you run into any trouble!

Set the 'updatemenu method' link directly to the method instead of the page header.
Bolded phrases and additional explanation in the "methods" section.
@SylwiaOliwia2
Copy link
Contributor Author

Did it, but please double-check :) I've been using Edit this page on Github, which created branch from my not updated fork.

@emmanuelle
Copy link
Contributor

thank you very much @SylwiaOliwia2 , merging ! 💃

@emmanuelle emmanuelle merged commit fc44222 into plotly:doc-prod Mar 26, 2020
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.

3 participants