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

Added documentation for Turtle module with code example #39

Merged
merged 3 commits into from
Oct 3, 2024

Conversation

yashi-025
Copy link
Contributor

Pull Request for PyVerse 💡

Issue Title : Complete Documentation and Code Implementation for Turtle Graphics

  • Info about the related issue (Aim of the project) : This project aims to provide comprehensive documentation and code implementation for the Turtle graphics library, enhancing its usability for beginners and educators. The documentation covers usage examples, functionalities, and code snippets to facilitate learning.
  • Name: Yashika Garg
  • GitHub ID: https://github.com/yashi-025
  • Email ID: [email protected]
  • Idenitfy yourself: (Mention in which program you are contributing in. Eg. For a WoB 2024 participant it's, WoB Participant) WoB 2024 Participant, IBM code global Participant

Closes: #issue number that will be closed through this PR #10

Describe the add-ons or changes you've made 📃

In this pull request, I have made the following contributions:

  • Created a complete documentation guide for the Turtle graphics library, detailing its features and functionalities.
  • Implemented two code snippets demonstrating the usage of key functions in the library:
  1. A code snippet for drawing spiral using Turtle graphics.
  2. A code snippet for creating interactive turtle drawings with user input.
  • Ensured that the documentation is user-friendly and suitable for both beginners and experienced users.

Type of change ☑️

What sort of change have you made:

[ ] Bug fix (non-breaking change which fixes an issue)
[ ☑️] New feature (non-breaking change which adds functionality)
[ ] Code style update (formatting, local variables)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ☑️] This change requires a documentation update

How Has This Been Tested? ⚙️

I have tested the documentation and code snippets by:

-Running the provided code snippets in the Turtle graphics environment to ensure they function as intended.
-Verifying that the documentation accurately reflects the code and provides clear guidance for users.

Checklist: ☑️

[☑️ ] My code follows the guidelines of this project.
[ ☑️] I have performed a self-review of my own code.
[ ☑️] I have commented my code, particularly wherever it was hard to understand.
[☑️ ] I have made corresponding changes to the documentation.
[☑️ ] My changes generate no new warnings.
[☑️ ] I have added things that prove my fix is effective or that my feature works.
[ ] Any dependent changes have been merged and published in downstream modules.

Copy link

github-actions bot commented Oct 2, 2024

👋 Thank you for opening this pull request! We're excited to review your contribution. Please give us a moment, and we'll get back to you shortly!

@github-actions github-actions bot requested a review from UTSAVS26 October 2, 2024 17:55
@UTSAVS26 UTSAVS26 added Contributor Denotes issues or PRs submitted by contributors to acknowledge their participation. Status: Approved PRs that have passed review and are approved for merging. WoB'24 (Winter of Blockchain) Contributions or tasks specific to the Winter of Blockchain 2024 event, focusing on blockchain-relat level1 labels Oct 3, 2024
@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 3, 2024

@yashi-025 please sync all the previous changes then create a pr as it is creating a conflict in the merge.

@yashi-025
Copy link
Contributor Author

@yashi-025 please sync all the previous changes then create a pr as it is creating a conflict in the merge.

Can you pls check now

@yashi-025
Copy link
Contributor Author

Could you please add the "hacktober-accepted" label as I recently registered for it as well?

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 3, 2024

Could you please add the "hacktober-accepted" label as I recently registered for it as well?

hacktober-accepted label is for GSSOC'24-Extd. Contributors, i can ask from WoB team if they allow then I will add label to this pr too. Till then all the best .

@UTSAVS26 UTSAVS26 merged commit 248cc69 into UTSAVS26:main Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contributor Denotes issues or PRs submitted by contributors to acknowledge their participation. level1 Status: Approved PRs that have passed review and are approved for merging. WoB'24 (Winter of Blockchain) Contributions or tasks specific to the Winter of Blockchain 2024 event, focusing on blockchain-relat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants