-
Notifications
You must be signed in to change notification settings - Fork 415
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
Updated the README for Tutorials #3519
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dopplershift
approved these changes
Aug 16, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for not responding to this sooner!
This is an excellent contribution, and is a great step to making the tutorials seem like a nicer place for people to learn more about MetPy.
Congrats on your first PR to MetPy! 🎉 We hope to see you around in the future! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
To improve the MetPy project, I updated the current README file for the tutorials. The goal was to provide clearer guidance and structure for users, making it easier for them to understand and utilize the tutorials effectively!
Files Changed
Updated README.md (located in the tutorials section):
Purpose of the Tutorials:
• Added a section explaining the objectives of the tutorials, detailing what users can expect to learn. This helps users
understand the overall goal and the value of going through the tutorials.
Link to Installation Guide and Examples Gallery:
• Provided a link to the MetPy installation guide to make sure users had the required dependencies properly installed
before attempting to complete a tutorial.
• Included a link to MetPy’s example gallery so users can see what else they can create using MetPy.
Descriptions of Current Tutorials:
• Provided brief descriptions of each available tutorial. This gives users an overview of the content and helps them select
tutorials that match their interests and needs.
Categorization by Difficulty:
• Organized the tutorials into sections based on their difficulty level (beginner, intermediate, advanced). This categorization
assists users in selecting the appropriate tutorial according to their skill level, facilitating a smoother learning curve.
Encouragement for Contribution:
• I included a small section encouraging users to contribute to the tutorials with links to the contributors guide. Hopefully a
user sees this message and feels encouraged to share their knowledge!
Checklist