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

[PyOpenSci] Documentation and Notebook Adjustments, manage SBCK #1338

Merged
merged 34 commits into from
Mar 31, 2023

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Mar 28, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • CHANGES.rst has been updated (with summary of main changes)
    • Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

  • Grammar and spelling mistakes within the notebooks have been corrected reduced.
  • SBCK has been pulled from environment.yml for the time being until a proper package is created.
  • The Contributing guide now lists three separate subsections to help users understand the gains from optional dependencies

Does this PR introduce a breaking change?

Yes, but no1. Changes to dependencies have been handled in such a way that default settings are unaffected. Development and CI-based behaviour is affected: clisops and flox are now in the environment.yml.

Other information:

yrobink/SBCK-python#5

Footnotes

  1. https://i.kym-cdn.com/entries/icons/original/000/028/596/dsmGaKWMeHXe9QuJtq_ys30PNfTGnMsRuHuo_MUzGCg.jpg

@Zeitsperre Zeitsperre added standards / conventions Suggestions on ways forward information For development/intsructional purposes docs Improvements to documenation labels Mar 28, 2023
@Zeitsperre Zeitsperre added this to the v0.42 milestone Mar 28, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions bot added the CI Automation and Contiunous Integration label Mar 28, 2023
@juliettelavoie
Copy link
Contributor

I removed seaborn. As I understand it, the point of this section is to show that the labels are integrated automatically on the plot from the attributes created by xclim. I thought this was illustrated well enough by matplotlib. I didn't see the added value of having seaborn also.

@Zeitsperre Zeitsperre marked this pull request as ready for review March 30, 2023 16:05
docs/installation.rst Outdated Show resolved Hide resolved
@Zeitsperre Zeitsperre requested a review from aulemahal March 30, 2023 18:06
@juliettelavoie
Copy link
Contributor

Re: plt.draw(). I left them there because I assumed there was a reason they were needed (like to show up on RtD or something), but I actually have no idea.

@Zeitsperre
Copy link
Collaborator Author

@juliettelavoie I was getting odd messages if plt.show() wasn't explicitly written. I saw that plt.draw() did what I wanted, so I went with that. This has been removed.

docs/notebooks/customize.ipynb Show resolved Hide resolved
docs/notebooks/ensembles.ipynb Show resolved Hide resolved
docs/notebooks/example.ipynb Show resolved Hide resolved
docs/notebooks/example.ipynb Show resolved Hide resolved
docs/notebooks/frequency_analysis.ipynb Show resolved Hide resolved
docs/notebooks/frequency_analysis.ipynb Show resolved Hide resolved
docs/notebooks/frequency_analysis.ipynb Show resolved Hide resolved
docs/notebooks/usage.ipynb Show resolved Hide resolved
@github-actions github-actions bot added the approved Approved for additional tests label Mar 31, 2023
docs/notebooks/analogs.ipynb Show resolved Hide resolved
docs/notebooks/example.ipynb Show resolved Hide resolved
docs/notebooks/units.ipynb Show resolved Hide resolved
@Zeitsperre Zeitsperre requested a review from coxipi March 31, 2023 20:15
@Zeitsperre Zeitsperre merged commit 3935907 into master Mar 31, 2023
@Zeitsperre Zeitsperre deleted the installation_comment_fixes branch March 31, 2023 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Approved for additional tests CI Automation and Contiunous Integration docs Improvements to documenation information For development/intsructional purposes priority Immediate priority standards / conventions Suggestions on ways forward
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can't create xclim environment : Failed to build sbck
5 participants