[New Entry/ Edits] Python Builtin-Functions: `super()`/ Inheritance #1008

beverand · 2022-09-16T07:45:37Z

Description

Closes #586

Type of Change

Adding a new entry
Editing an existing entry (fixing a typo, bug, issues, etc)

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.
Under "Development" on the right, I have linked any issues that are relevant to this PR (write "Closes # in the "Description" above).

CLAassistant · 2022-09-16T07:45:41Z

All committers have signed the CLA.

beverand · 2022-09-16T07:50:42Z

Added the super() term as discussed in issue #586

created super.md under python/concepts/built-in-functions/terms/super
removed super() from python inheritance entry

Dusch4593 · 2022-09-16T20:59:54Z

Added the super() term as discussed in issue #586

created super.md under python/concepts/built-in-functions/terms/super

removed super() from python inheritance entry

@beverand Thanks for submitting this PR! I'm looking forward to conducting the first review for this 😄

Quick tip: For your next PR, if you write "Closes #[this issue number]" (per the GitHub docs) in the "Description" near the top of the PR, the related issue will be linked to the PR. (No worries for this one, though; just edited the description 😎)

Dusch4593

@beverand Finished with my review and just left some comments/suggestions for you to check out. I might have more later but I wanted to give you a chance to look at what I have so far. Let me know if you have any questions. 😄

content/python/concepts/built-in-functions/terms/super/super.md

Dusch4593 · 2022-09-16T21:20:43Z

content/python/concepts/built-in-functions/terms/super/super.md

+## Example
+In this case, the `.say_hi()` method is implemented utilizing `super()` inside `.intro()`:
+
+```py


Suggested change

```py

```codebyte/python

content/python/concepts/built-in-functions/terms/super/super.md

content/python/concepts/inheritance/inheritance.md

content/python/concepts/built-in-functions/terms/super/super.md

Dusch4593 · 2022-09-16T21:26:40Z

content/python/concepts/built-in-functions/terms/super/super.md

@@ -0,0 +1,53 @@
+---
+Title: 'super()'
+Description: 'implicitly refer to the superclass'


Suggested change

Description: 'implicitly refer to the superclass'

Description: 'Returns a temporary object that allows a given class to inherit the methods and properties of a parent or sibling class.'

Let's make sure to use capitalization and punctuation. 😄

beverand · 2022-09-16T21:45:22Z

Thank you so much for the review. I didn't think it was going to be perfect so I was fully anticipating that corrections would need to be made. I will try to get these modifications in tonight and resubmit.

…

On Fri, Sep 16, 2022 at 2:27 PM Brandon Dusch ***@***.***> wrote: ***@***.**** requested changes on this pull request. @beverand <https://github.com/beverand> Finished with my review and just left some comments/suggestions for you to check out. I might have more later but I wanted to give you a chance to look at what I have so far. Let me know if you have any questions. 😄 ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > @@ -0,0 +1,53 @@ +--- +Title: 'super()' +Description: 'implicitly refer to the superclass' +Subjects: + - 'Computer Science' ⬇️ Suggested change - - 'Computer Science' + - 'Computer Science' + - 'Data Science' Since Python is commonly used in data science. ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > @@ -0,0 +1,53 @@ +--- +Title: 'super()' +Description: 'implicitly refer to the superclass' +Subjects: + - 'Computer Science' +Tags: + - 'Functions' + - 'Objects' + - 'Inheritance' +CatalogContent: + - 'learn-python-3' + - 'paths/computer-science' +--- + +The `super()` function is built into python and is used to refer to the the superclass of an object without specifically using the parent name. ⬇️ Suggested change -The `super()` function is built into python and is used to refer to the the superclass of an object without specifically using the parent name. +The **`super()`** function returns a temporary object that allows a given [class](https://www.codecademy.com/resources/docs/python/classes) to [inherit](https://www.codecademy.com/resources/docs/python/inheritance) the methods and properties of a parent or sibling class. ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > +--- + +The `super()` function is built into python and is used to refer to the the superclass of an object without specifically using the parent name. + +## Syntax + +```pseudo +super().function() +super(type) +``` + +## `super()` + +`super()` returns a temporary object of the superclass, allowing the superclass’s methods to be called. This comes in handy when using [multiple inheritance](#multiple-inheritance). + +## Example ⬇️ Suggested change -## Example +## Codebyte Example Let's allow one empty line above and below each header. ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > + +## Syntax + +```pseudo +super().function() +super(type) +``` + +## `super()` + +`super()` returns a temporary object of the superclass, allowing the superclass’s methods to be called. This comes in handy when using [multiple inheritance](#multiple-inheritance). + +## Example +In this case, the `.say_hi()` method is implemented utilizing `super()` inside `.intro()`: + +```py ⬇️ Suggested change -```py +```codebyte/python ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > + +The output would be: + +```shell +Hi! I am a Programming Language. +Python here! +``` ⬇️ Suggested change - -The output would be: - -```shell -Hi! I am a Programming Language. -Python here! -``` If we choose to go with a Codebyte example, then these lines can be omitted; the output will appear on the screen after the code is run. ------------------------------ In content/python/concepts/inheritance/inheritance.md <#1008 (comment)>: > @@ -68,28 +68,6 @@ Python here! **Note**: Inside the child class, the same number and type of arguments need to be passed into the parent class' method. ⬇️ Suggested change -**Note**: Inside the child class, the same number and type of arguments need to be passed into the parent class' method. +> **Note:** Inside the child class, the same number and type of arguments need to be passed into the parent class' method. ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > + - 'Functions' + - 'Objects' + - 'Inheritance' ⬇️ Suggested change - - 'Functions' - - 'Objects' - - 'Inheritance' + - 'Classes' + - 'Functions' + - 'Inheritance' + - 'Methods' + - 'Objects' + - 'OOP' ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > @@ -0,0 +1,53 @@ +--- +Title: 'super()' +Description: 'implicitly refer to the superclass' ⬇️ Suggested change -Description: 'implicitly refer to the superclass' +Description: 'Returns a temporary object that allows a given class to inherit the methods and properties of a parent or sibling class.' Let's make sure to use capitalization and punctuation. 😄 ------------------------------ In content/python/concepts/built-in-functions/terms/super/super.md <#1008 (comment)>: > +--- + +The `super()` function is built into python and is used to refer to the the superclass of an object without specifically using the parent name. + +## Syntax + +```pseudo +super().function() +super(type) +``` + +## `super()` + +`super()` returns a temporary object of the superclass, allowing the superclass’s methods to be called. This comes in handy when using [multiple inheritance](#multiple-inheritance). + +## Example Also let's rename this to "Codebyte Example" since Python is a supported language for runnable code snippets <https://help.codecademy.com/hc/en-us/articles/1260806285369-Codebytes> (which is compatible with Codecademy Docs 😄) ------------------------------ In content/python/concepts/inheritance/inheritance.md <#1008 (comment)>: > @@ -68,28 +68,6 @@ Python here! **Note**: Inside the child class, the same number and type of arguments need to be passed into the parent class' method. Also, near the top on line # 16, can we *bold* the word "Inheritance"? — Reply to this email directly, view it on GitHub <#1008 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEZUG6WHXZNSDMRI3GVT4E3V6TQ5VANCNFSM6AAAAAAQOCNCAQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

content/python/concepts/inheritance/inheritance.md

Dusch4593 · 2022-09-16T22:52:30Z

@beverand I would undo the changes in 4e8541e. When I suggested bolding "Inheritance" I meant the edit should happen in line # 16 in the inheritance.md file (not the super.md file). Content in the meta-information (first 13-15 lines of the file) should not be emphasized in any way.

This reverts commit 4e8541e.

beverand · 2022-09-16T23:00:39Z

Thank you for your patience helping me. I admit, I'm using vi in the terminal for all of my edits.

Dusch4593 · 2022-09-16T23:02:29Z

Thank you for your patience helping me. I admit, I'm using vi in the terminal for all of my edits.

I'm always happy to help 😄 and kudos for working with the repo through the vi editor!

Dusch4593 · 2022-09-16T23:20:53Z

@beverand Would you be open to trying to format the entry on your side with the following command when you get a chance?

yarn format content/python/concepts/built-in-functions/terms/super/super.md content/python/concepts/inheritance/inheritance.md

Dusch4593 · 2022-09-16T23:21:30Z

@beverand Would you be open to trying to format the entry on your side with the following command when you get a chance?
yarn format content/python/concepts/built-in-functions/terms/super/super.md content/python/concepts/inheritance/inheritance.md

And then add, commit, and push the changes like you normally would?

beverand · 2022-09-16T23:31:44Z

I think there are things I have to install to make that work

…

On Fri, Sep 16, 2022 at 4:21 PM Brandon Dusch ***@***.***> wrote: @beverand <https://github.com/beverand> Would you be open to trying to format the entry on your side with the following command when you get a chance? yarn format content/python/concepts/built-in-functions/terms/super/super.md content/python/concepts/inheritance/inheritance.md — Reply to this email directly, view it on GitHub <#1008 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEZUG6XITOB5UZ2QZW3QWLTV6T6F7ANCNFSM6AAAAAAQOCNCAQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

beverand · 2022-09-16T23:42:50Z

I am getting errors. Something with prettier or something with Arborist. On Fri, Sep 16, 2022 at 4:31 PM Beverly Andrews ***@***.***> wrote:

…

I think there are things I have to install to make that work On Fri, Sep 16, 2022 at 4:21 PM Brandon Dusch ***@***.***> wrote: > @beverand <https://github.com/beverand> Would you be open to trying to > format the entry on your side with the following command when you get a > chance? > > yarn format content/python/concepts/built-in-functions/terms/super/super.md content/python/concepts/inheritance/inheritance.md > > — > Reply to this email directly, view it on GitHub > <#1008 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AEZUG6XITOB5UZ2QZW3QWLTV6T6F7ANCNFSM6AAAAAAQOCNCAQ> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >

Dusch4593 · 2022-09-16T23:43:18Z

I am getting errors. Something with prettier or something with Arborist. On Fri, Sep 16, 2022 at 4:31 PM Beverly Andrews @.> wrote:
…
I think there are things I have to install to make that work On Fri, Sep 16, 2022 at 4:21 PM Brandon Dusch @.> wrote: > @beverand https://github.com/beverand Would you be open to trying to > format the entry on your side with the following command when you get a > chance? > > yarn format content/python/concepts/built-in-functions/terms/super/super.md content/python/concepts/inheritance/inheritance.md > > — > Reply to this email directly, view it on GitHub > <#1008 (comment)>, > or unsubscribe > https://github.com/notifications/unsubscribe-auth/AEZUG6XITOB5UZ2QZW3QWLTV6T6F7ANCNFSM6AAAAAAQOCNCAQ > . > You are receiving this because you were mentioned.Message ID: > @.***> >

Any chance you could copy/paste the exact error message here?

Dusch4593

Hey @beverand! I found a few last areas for suggestions and comments on my end before we merge. After you've implemented this last batch of feedback and @KTom101 and I approve the changes, we should be good for merge. 😄

Btw, I just wanna give you kudos for the work you've put into this PR this week. This is an incredibly important and oft-used Python function that has a lot packed into it. Major props! We can't wait for your contribution to come alive when it gets merged! 🚀

content/python/concepts/inheritance/inheritance.md

content/python/concepts/built-in-functions/terms/super/super.md

Dusch4593 · 2022-09-23T14:21:22Z

content/python/concepts/built-in-functions/terms/super/super.md

+super(type, object)
+```
+
+`.method()` is the accessed method of the parent class. `type` specifies the type object of the parent class and object is an instance or subtype of the `type`.


Suggested change

`.method()` is the accessed method of the parent class. `type` specifies the type object of the parent class and object is an instance or subtype of the `type`.

The `type` specifies the object type of the parent class and `object` is an instance or subtype of the `type`.

The `super()` function is commonly applied to a single-inheritance class hierarchy:

content/python/concepts/built-in-functions/terms/super/super.md

Dusch4593 · 2022-09-23T14:23:09Z

content/python/concepts/built-in-functions/terms/super/super.md

+
+`super()` returns a temporary object of the superclass, allowing the superclass’s methods to be called. This comes in handy when using multiple inheritance to derive a class from more than one base class.
+
+## Codebyte Example


Just one Codebyte example + snippet per entry. Since both snippets produce the same output, I would suggest using one Codebyte snippet that implement both syntaxes.

content/python/concepts/built-in-functions/terms/super/super.md

content/python/concepts/inheritance/inheritance.md

KTom101

@beverand Added a few more changes, mainly concerning the second codebyte. We only want one codebyte on the page and it should be at the end. I've added changes to reflect that.

content/python/concepts/built-in-functions/terms/super/super.md

Co-authored-by: KTom101 <kyrathompson@me.com>

…xample" Co-authored-by: KTom101 <kyrathompson@me.com>

Co-authored-by: KTom101 <kyrathompson@me.com>

Co-authored-by: Brandon Dusch <brandondusch@gmail.com>

Dusch4593

Hey @beverand! Thank you very much for the last batch of changes 😄 I think everything looks good from my end. I applied some changes that I wanted to let you know about:

Added two subsections under "Syntax" that describe how both syntaxes (with and without arguments) can be applied inside and outside a class definition.
Changed the example section into a Codebyte.
Removed "## super" heading and text that originally came from the Python concept entry about inheritance.

KTom101

@beverand @Dusch4593 The new changes look great! 👍

KTom101 · 2022-09-26T17:53:29Z

Live links are up!
super() : https://www.codecademy.com/resources/docs/python/built-in-functions/super
Inheritance : https://www.codecademy.com/resources/docs/python/inheritance

Dusch4593 · 2022-09-26T18:24:23Z

Thanks for posting those, @KTom101!

Hey @beverand I noticed that your Codecademy profile isn't appearing on the page for super()?

Have you connected your Codecademy profile with your GitHub account? Happy to help with the steps so you receive credit as a contributor this content. 😄

…1008) * add definition for python super() * Made set of updateds for spacing and content improvement * Removed note * Bold inheritance in tag list * Revert "Bold inheritance in tag list" This reverts commit 4e8541e. * Bold Inheritance on line 16 * Removed extra line * Ran npm run format on super.md and inheirtance.md * Update content/python/concepts/inheritance/inheritance.md * Update content/python/concepts/built-in-functions/terms/super/super.md * Update content/python/concepts/built-in-functions/terms/super/super.md * Additional changes from second review update links and text changes * remove yarn.lock * Move text from above pseudo to below it * add yarn.lock back * Delete yarn.lock * added yarn.lock back (again) * re-mirrored yarn.lock against one from main branch * Update content/python/concepts/built-in-functions/terms/super/super.md * Updated super(type) to super(type, object) with example * Update reference to 'object' in pseudocode to 'obj' * remove line at 73 * Update intro to example from "this case" to "the following codebyte example" * remove line at 56 * Shorten reference from "object" to "obj" * Change example intro at line 39 * Remove Codebyte from example * Reverse change from codebyte/python back to py * Clarify child and subclass references * Update to note add > * Add 'Classes' to tags * Updates including mod to codebyte example and additional pseudo code * some last edits

add definition for python super()

b7e1947

Dusch4593 linked an issue Sep 16, 2022 that may be closed by this pull request

[Term Entry] Python Built-in Functions: super() #586

Closed

3 tasks

Dusch4593 changed the title ~~add definition for python super()~~ [New Entry/ Edits] Python Builtin-Functions: super()/ Sep 16, 2022

Dusch4593 changed the title ~~[New Entry/ Edits] Python Builtin-Functions: super()/~~ [New Entry/ Edits] Python Builtin-Functions: super()/ Inheritance Sep 16, 2022

Dusch4593 added enhancement New feature or request python Python entries new entry New entry or entries labels Sep 16, 2022

Dusch4593 suggested changes Sep 16, 2022

View reviewed changes

Dusch4593 self-assigned this Sep 16, 2022

Dusch4593 added status: review 1️⃣ completed status: waiting for author labels Sep 16, 2022

Made set of updateds for spacing and content improvement

5b56315

Dusch4593 suggested changes Sep 16, 2022

View reviewed changes

content/python/concepts/inheritance/inheritance.md Outdated Show resolved Hide resolved

beverand added 2 commits September 16, 2022 15:41

Removed note

2a3868c

Bold inheritance in tag list

4e8541e

Revert "Bold inheritance in tag list"

27c8813

This reverts commit 4e8541e.

beverand added 2 commits September 16, 2022 16:12

Bold Inheritance on line 16

d10ece8

Removed extra line

305fa50

Dusch4593 suggested changes Sep 23, 2022

View reviewed changes

Dusch4593 added status: review 2️⃣ completed status: waiting for author labels Sep 23, 2022

KTom101 reviewed Sep 23, 2022

View reviewed changes

beverand and others added 12 commits September 23, 2022 11:05

Update reference to 'object' in pseudocode to 'obj'

208a536

Co-authored-by: KTom101 <kyrathompson@me.com>

remove line at 73

6229e9a

Co-authored-by: KTom101 <kyrathompson@me.com>

Update intro to example from "this case" to "the following codebyte e…

ad696a8

…xample" Co-authored-by: KTom101 <kyrathompson@me.com>

remove line at 56

a32392f

Co-authored-by: KTom101 <kyrathompson@me.com>

Shorten reference from "object" to "obj"

710956d

Co-authored-by: KTom101 <kyrathompson@me.com>

Change example intro at line 39

c3ea348

Co-authored-by: KTom101 <kyrathompson@me.com>

Remove Codebyte from example

72352dc

Co-authored-by: KTom101 <kyrathompson@me.com>

Reverse change from codebyte/python back to py

1e1e5e8

Co-authored-by: KTom101 <kyrathompson@me.com>

Clarify child and subclass references

318bfe5

Co-authored-by: Brandon Dusch <brandondusch@gmail.com>

Update to note add >

983e419

Co-authored-by: Brandon Dusch <brandondusch@gmail.com>

Add 'Classes' to tags

e477f1a

Updates including mod to codebyte example and additional pseudo code

2054f70

beverand requested review from Dusch4593 and KTom101 and removed request for Dusch4593 September 23, 2022 23:48

Dusch4593 added the hacktoberfest label Sep 26, 2022

Dusch4593 added 2 commits September 26, 2022 12:30

some last edits

9dd45cb

Merge branch 'main' into docsuper

d56e8a2

Dusch4593 approved these changes Sep 26, 2022

View reviewed changes

KTom101 approved these changes Sep 26, 2022

View reviewed changes

Dusch4593 removed the status: waiting for author label Sep 26, 2022

Dusch4593 merged commit fe883b6 into Codecademy:main Sep 26, 2022

Dusch4593 added the hacktoberfest-accepted Indicates the PR was approved, merged, and pertains to Hacktoberfest label Oct 7, 2022

	Description: 'implicitly refer to the superclass'
	Description: 'Returns a temporary object that allows a given class to inherit the methods and properties of a parent or sibling class.'

-`.method()` is the accessed method of the parent class. `type` specifies the type object of the parent class and object is an instance or subtype of the `type`.
+The `type` specifies the object type of the parent class and `object` is an instance or subtype of the `type`.
+The `super()` function is commonly applied to a single-inheritance class hierarchy:


		`super()` returns a temporary object of the superclass, allowing the superclass’s methods to be called. This comes in handy when using multiple inheritance to derive a class from more than one base class.

		## Codebyte Example

[New Entry/ Edits] Python Builtin-Functions: super()/ Inheritance #1008

[New Entry/ Edits] Python Builtin-Functions: super()/ Inheritance #1008

Uh oh!

Conversation

beverand commented Sep 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Checklist

Uh oh!

CLAassistant commented Sep 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beverand commented Sep 16, 2022

Uh oh!

Dusch4593 commented Sep 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dusch4593 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dusch4593 Sep 16, 2022

Choose a reason for hiding this comment

Uh oh!

beverand Sep 16, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dusch4593 Sep 16, 2022

Choose a reason for hiding this comment

Uh oh!

beverand Sep 16, 2022

Choose a reason for hiding this comment

Uh oh!

beverand commented Sep 16, 2022 via email

Uh oh!

Uh oh!

Dusch4593 commented Sep 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beverand commented Sep 16, 2022

Uh oh!

Dusch4593 commented Sep 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dusch4593 commented Sep 16, 2022

Uh oh!

Dusch4593 commented Sep 16, 2022

Uh oh!

beverand commented Sep 16, 2022 via email

Uh oh!

beverand commented Sep 16, 2022 via email

Uh oh!

Dusch4593 commented Sep 16, 2022

Uh oh!

Dusch4593 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dusch4593 Sep 23, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Dusch4593 Sep 23, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KTom101 left a comment

Choose a reason for hiding this comment

Uh oh!

[New Entry/ Edits] Python Builtin-Functions: `super()`/ Inheritance #1008

[New Entry/ Edits] Python Builtin-Functions: `super()`/ Inheritance #1008

beverand commented Sep 16, 2022 •

edited

Loading

CLAassistant commented Sep 16, 2022 •

edited

Loading

Dusch4593 commented Sep 16, 2022 •

edited

Loading

Dusch4593 commented Sep 16, 2022 •

edited

Loading

Dusch4593 commented Sep 16, 2022 •

edited

Loading

Dusch4593 left a comment •

edited

Loading