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

📃CAPE CIN documentation #14

Merged
merged 1 commit into from
Jun 7, 2024
Merged

📃CAPE CIN documentation #14

merged 1 commit into from
Jun 7, 2024

Conversation

leaver2000
Copy link
Owner

@leaver2000 leaver2000 commented Jun 7, 2024

Summary by Sourcery

This pull request enhances the documentation by adding a new section on CAPE and CIN calculations in the README.md. It also updates the notebook to reflect changes in the cape_cin function usage and removes an unused file.

  • Documentation:
    • Added a new section in the README.md to document the CAPE and CIN calculations, including code examples and visualizations.
  • Tests:
    • Updated notebook.ipynb to remove the use of the fast_approximate parameter in the cape_cin function calls.
  • Chores:
    • Deleted an unused file c.ipynb from the repository.

Copy link

sourcery-ai bot commented Jun 7, 2024

Reviewer's Guide by Sourcery

This pull request adds documentation for CAPE (Convective Available Potential Energy) and CIN (Convective Inhibition) calculations in the README.md file. It also updates the notebook.ipynb file to remove the 'fast_approximate' parameter from the 'cape_cin' function calls and deletes the c.ipynb file.

File-Level Changes

Files Changes
README.md
notebook.ipynb
Updated documentation and code examples for CAPE and CIN calculations, including the removal of the 'fast_approximate' parameter from function calls.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@leaver2000 leaver2000 merged commit 9d1dc30 into master Jun 7, 2024
1 check failed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @leaver2000 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 6 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
notebook.ipynb Show resolved Hide resolved
notebook.ipynb Show resolved Hide resolved
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.

1 participant