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

Term entry difference update py 4617 #4668

Merged

Conversation

JenHunnisett
Copy link
Contributor

Description

This is a new term entry for the '.difference_update()' method for Sets in Python. The entry is in a new file under docs/content/python/concepts/sets/terms/difference-update/difference-update.md

The entry includes the following:

A description of the function
A ## Syntax section that includes the syntax of the function and its details
An ## Example section that includes a python codeblock and shell that shows the example output.
A ## Codebyte Example that includes a codebyte/python runnable codeblock

My motivation to do this is I'm trying to brush up my rusty coding skills, so I've been learning python on the codecademy data science foundations course, wanted to start contributing to OS projects, and then realised I'd only really used git with SVN in the past, so decided to do the codecademy git & github course, which contains a mini project to make a contribution to the docs!

Issue Solved

Closes #4617

Type of Change

  • Adding a new entry

Checklist

  • All writings are my own.
  • My entry follows the Codecademy Docs style guide.
  • My changes generate no new warnings.
  • I have performed a self-review of my own writing and code.
  • I have checked my entry and corrected any misspellings.
  • I have made corresponding changes to the documentation if needed.
  • I have confirmed my changes are not being pushed from my forked main branch.
  • I have confirmed that I'm pushing from a new branch named after the changes I'm making.
  • I have linked any issues that are relevant to this PR in the Issues Solved section.

@CLAassistant
Copy link

CLAassistant commented May 18, 2024

CLA assistant check
All committers have signed the CLA.

@mamtawardhani mamtawardhani self-assigned this May 18, 2024
@mamtawardhani mamtawardhani added python Python entries new entry New entry or entries status: under review Issue or PR is currently being reviewed labels May 18, 2024
Copy link
Collaborator

@mamtawardhani mamtawardhani left a comment

Choose a reason for hiding this comment

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

Hey @JenHunnisett! Thank you for contributing to the Codecademy Docs! The entry is well written!

I've added suggestions at some places for this entry, could you please review and modify those at your earliest convenience?
Thank you! 😄

JenHunnisett and others added 3 commits May 21, 2024 12:45
Co-authored-by: Mamta Wardhani <53176352+mamtawardhani@users.noreply.github.com>
…e-update.md

Co-authored-by: Mamta Wardhani <53176352+mamtawardhani@users.noreply.github.com>
…e-update.md

Co-authored-by: Mamta Wardhani <53176352+mamtawardhani@users.noreply.github.com>
@JenHunnisett
Copy link
Contributor Author

JenHunnisett commented May 21, 2024

@mamtawardhani thank you for your review of my work, it was very helpful :-)

I think I have reviewed and committed all but one of your suggestions, and that one I just couldn't see what the difference was, apologies if I'm being obtuse!

I'm also new to using github so please let me know if I've made any mistakes in the way I've used it.

Thankyou! J

@mamtawardhani
Copy link
Collaborator

@JenHunnisett no worries at all, happy to help! That one suggestion left means that line can be removed.

…e-update.md

Co-authored-by: Mamta Wardhani <53176352+mamtawardhani@users.noreply.github.com>
@JenHunnisett
Copy link
Contributor Author

@mamtawardhani I think I have incorporated all your suggested changes now :-)
Let me know what I need to do next, thank you!

Copy link
Collaborator

@mamtawardhani mamtawardhani left a comment

Choose a reason for hiding this comment

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

Thank you for making the required changes @JenHunnisett! 😄

The entry looks good for the second review 👍

@JenHunnisett
Copy link
Contributor Author

@Sriparno08 let me know if you need anything from me :-) thankyou!

@Sriparno08
Copy link
Collaborator

There's nothing needed from your side as of now, @JenHunnisett. If needed, I'll let you know.

Copy link
Collaborator

@Sriparno08 Sriparno08 left a comment

Choose a reason for hiding this comment

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

Looks good, @JenHunnisett! 👍

@Sriparno08 Sriparno08 merged commit f2353d5 into Codecademy:main May 29, 2024
6 checks passed
@Sriparno08 Sriparno08 added status: review 2️⃣ completed and removed status: under review Issue or PR is currently being reviewed labels May 29, 2024
Copy link

👋 @JenHunnisett
You have contributed to Codecademy Docs, and we would like to know more about you and your experience.
Please take a minute to fill out this four question survey to help us better understand Docs contributions and how we can improve the experience for you and our learners.
Thank you for your help!

🎉 Your contribution(s) can be seen here:

https://www.codecademy.com/resources/docs/python/sets/difference-update

Please note it may take a little while for changes to become visible.
If you're appearing as anonymous and want to be credited, see here.

@JenHunnisett JenHunnisett deleted the term_entry_difference_update_py_4617 branch May 29, 2024 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Term Entry] Python sets .difference_update()
4 participants