[New Term] Python Built-in Functions: `help()` #1486

alenn97 · 2023-01-11T16:38:25Z

Description

Type of Change

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

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 · 2023-01-11T16:38:30Z

All committers have signed the CLA.

Dusch4593 · 2023-01-11T16:51:28Z

Amazing! Thank you for submitting this, @alenn97 🎉

Either myself or one of my colleagues will step fourth to perform a review for this PR. After at least 2 reviews have been approved, we should be ready to merge this.

One last piece of advice I'd like to offer regarding your Docs fork: Since new changes are constantly being merged into the main branch of the base Codecademy/docs repo, this will sometimes put your fork's main branch x-commits behind:

Before starting a new PR branch for next entry, you'll need to make sure this is caught up on GitHub, like so:

Then, on your terminal, go back to your main branch with git checkout main and then run git pull to catch things up on the local end.

alenn97 · 2023-01-11T16:57:52Z

Thank you.
If the update is needed for this pull request I will do it as soon as I can.

SSwiniarski

@alenn97 I did a first review and only had a couple of comments.

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

SSwiniarski

@alenn97 aside from a couple of comments about spacing, this looks ready for a second review.

SSwiniarski · 2023-01-14T12:45:17Z

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

+
+```py
+help(print)
+```


There need to be line breaks before and after code blocks

Should I commit a new version with the correct spacing right now or do I have to wait for the second review?

@alenn97 Go ahead and commit a new version.

SSwiniarski · 2023-01-14T12:46:00Z

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

+```py
+help()
+```
+Which returns as output:


There need to be line breaks before and after code blocks.

@alenn97 after applying these line breaks, I would then suggest we switch the two examples in this "Example" section. So, the first example should be help() + start screen, followed by help(print) + documentation results.

Dusch4593 · 2023-01-14T19:34:53Z

@alenn97 I'm going to take a look for review 2️⃣ 😄

Dusch4593

@alenn97 left you some comments/suggestions for review 2️⃣

Let us know if you have any questions or need any assistance with implementing the feedback. 😄

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

Dusch4593 · 2023-01-14T20:04:10Z

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

+```py
+help()
+```
+Which returns as output:


@alenn97 after applying these line breaks, I would then suggest we switch the two examples in this "Example" section. So, the first example should be help() + start screen, followed by help(print) + documentation results.

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

Dusch4593

@alenn97 This looks good to merge! I made the following edits in 1699869 before doing so:

Combined lines # 24 and 25 into one sentence (now just line # 24).
Small edits on line # 26 and # 30.
Removed extra spacing to get the GitHub checks to pass.

github-actions · 2023-01-17T17:03:40Z

👋 @alenn97
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!

Dusch4593 · 2023-01-17T17:09:29Z

Congratulations and thank you so much for contributing to Codecademy Docs, @alenn97! 🎊 🥳 🎉

I'm super proud of you for sticking through the whole process, from the repo setup to PR and reviews!

The new entry should now be live: https://www.codecademy.com/resources/docs/python/built-in-functions/help

Looking forward to your next Docs contribution! 😄

Dusch4593 added python Python entries new entry New entry or entries status: ready for next review labels Jan 11, 2023

Dusch4593 changed the title ~~add new term entry about the help() function~~ [New Term] Python Built-in Functions: help() Jan 11, 2023

SSwiniarski self-assigned this Jan 11, 2023

SSwiniarski added status: under review Issue or PR is currently being reviewed and removed status: ready for next review labels Jan 11, 2023

SSwiniarski suggested changes Jan 11, 2023

View reviewed changes

content/python/concepts/built-in-functions/terms/help/help.md Outdated Show resolved Hide resolved

content/python/concepts/built-in-functions/terms/help/help.md Outdated Show resolved Hide resolved

SSwiniarski added status: review 1️⃣ completed status: waiting for author and removed status: under review Issue or PR is currently being reviewed labels Jan 11, 2023

alenn97 added 2 commits January 12, 2023 10:36

add new term entry about the help() function

97d0552

add shell block for output section

f61a7ed

alenn97 force-pushed the help_command branch from 6ba02e4 to f61a7ed Compare January 12, 2023 10:20

alenn97 added 2 commits January 12, 2023 21:24

modify line 57

413a2f8

Merge branch 'main' into help_command

24c2720

alenn97 requested a review from SSwiniarski January 14, 2023 12:03

SSwiniarski removed the status: waiting for author label Jan 14, 2023

SSwiniarski approved these changes Jan 14, 2023

View reviewed changes

SSwiniarski added the status: ready for next review label Jan 14, 2023

Merge branch 'main' into help_command

7c24629

Dusch4593 self-requested a review January 14, 2023 19:35

Dusch4593 self-assigned this Jan 14, 2023

Dusch4593 added status: under review Issue or PR is currently being reviewed and removed status: ready for next review labels Jan 14, 2023

Dusch4593 suggested changes Jan 14, 2023

View reviewed changes

Dusch4593 added status: waiting for author and removed status: under review Issue or PR is currently being reviewed labels Jan 14, 2023

SSwiniarski linked an issue Jan 15, 2023 that may be closed by this pull request

[Term Entry] Python Built-in Functions: help() #1481

Closed

3 tasks

modify text according to reviews

54d8f91

alenn97 requested a review from Dusch4593 January 15, 2023 20:11

SSwiniarski and others added 2 commits January 16, 2023 08:00

Merge branch 'main' into help_command

a2554df

Update help.md

1699869

Dusch4593 approved these changes Jan 17, 2023

View reviewed changes

Merge branch 'main' into help_command

6efe07d

Dusch4593 added status: review 2️⃣ completed and removed status: waiting for author labels Jan 17, 2023

Dusch4593 merged commit c165959 into Codecademy:main Jan 17, 2023

[New Term] Python Built-in Functions: help() #1486

[New Term] Python Built-in Functions: help() #1486

Uh oh!

Conversation

alenn97 commented Jan 11, 2023 • edited by Dusch4593 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Checklist

Uh oh!

CLAassistant commented Jan 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dusch4593 commented Jan 11, 2023

Uh oh!

alenn97 commented Jan 11, 2023

Uh oh!

SSwiniarski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

SSwiniarski left a comment

Choose a reason for hiding this comment

Uh oh!

SSwiniarski Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

alenn97 Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

SSwiniarski Jan 14, 2023 • 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!

SSwiniarski Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

Dusch4593 Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

Dusch4593 commented Jan 14, 2023

Uh oh!

Dusch4593 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dusch4593 Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

github-actions bot commented Jan 17, 2023

Uh oh!

Dusch4593 commented Jan 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[New Term] Python Built-in Functions: `help()` #1486

[New Term] Python Built-in Functions: `help()` #1486

alenn97 commented Jan 11, 2023 •

edited by Dusch4593

Loading

CLAassistant commented Jan 11, 2023 •

edited

Loading

SSwiniarski Jan 14, 2023 •

edited

Loading

Dusch4593 left a comment •

edited

Loading