Skip to content

Conversation

sharkipelago
Copy link
Contributor

Description

Added information and example of Type Error in Python Errors entry.

Type of Change

  • 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
Copy link

CLAassistant commented Aug 7, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@SSwiniarski SSwiniarski left a comment

Choose a reason for hiding this comment

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

@sharkipelago, this looks good for a second review. Thanks for catching this and making a contribution!

@SSwiniarski SSwiniarski self-assigned this Aug 9, 2022
@SSwiniarski SSwiniarski added enhancement New feature or request python Python entries typo Fixing a typo status: review 1️⃣ completed labels Aug 9, 2022
Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@sharkipelago Finished with my review and left you some comments/suggestions 😄

@sharkipelago
Copy link
Contributor Author

@Dusch4593 I think I was able to fix the things you pointed out. Do I need to do something to request feedback again?

Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@sharkipelago Actually, tagging one of us is all you need to do to let us know you've finished implementing changes to the PR from your side.

Thank you, btw, for implementing all those suggested changes! 😄 I left one more suggestion under errors.md, but other than that everything LGTM! 👍🏻

@sharkipelago
Copy link
Contributor Author

@Dusch4593 Thanks for the feedback I corrected the last single-quote and the test passed locally, so hopefully it's all good. Also sorry I did not sync my branch with main before doing the latest correction. In general should I rebase or merge the main changes?

@SSwiniarski
Copy link
Contributor

@sharkipelago, No worries, I merged it when running the checks on your PR.

Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@sharkipelago Had a couple more comments/suggestions for you 😄


## Syntax Errors

Syntax errors, also known as parsing errors, are perhaps the most common kind of complaint you get while you are still learning Python:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Syntax errors, also known as parsing errors, are perhaps the most common kind of complaint you get while you are still learning Python:
Syntax errors (also known as parsing errors) occur when a sequence of characters, or tokens, violates the syntax of the Python programming language:

For the rest of this entry, let's replace all instances of "you" with a neutral, more manual-like tone that doesn't address the reader(s) directly.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, on line # 15, can we change to make it look similar to the Description on line # 3. Also, since "errors" is the entry concept, let's place it in bold. Maybe something like this:

"The two types of errors are syntax errors and exceptions."

@sharkipelago
Copy link
Contributor Author

@Dusch4593 Made the corrections :)

Copy link
Contributor

@Dusch4593 Dusch4593 left a comment

Choose a reason for hiding this comment

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

@sharkipelago Thank you for the changes! This PR seems ready for merge (I made a small change to the opening sentence in c097860).

@Dusch4593 Dusch4593 merged commit 78bbc49 into Codecademy:main Aug 22, 2022
@Dusch4593
Copy link
Contributor

Dusch4593 commented Aug 22, 2022

Congratulations @sharkipelago, it looks like your changes were merged and are now live in the Python: Errors entry! 🎉 🎊

Quick question, though. Is your GitHub handle linked to your Codecademy profile? Although I see your changes, I don't see your profile credited near the top-right:

Screen Shot 2022-08-22 at 4 31 44 PM

@sharkipelago
Copy link
Contributor Author

@Dusch4593 Thanks for merging them! I think my github account is linked? I made this PR before linking it though, I'm not sure if that impacts anything. All I had to do was put my handle in the profile right?
image

@Dusch4593
Copy link
Contributor

Dusch4593 commented Aug 22, 2022

@sharkipelago in addition to that, you may have to log out of your Codecademy account and re-login through your GitHub account. (see CONTRIBUTING.md for more details)

Screen Shot 2022-08-22 at 6 46 51 PM

After doing so, let's wait for a few minutes and check the Errors entry, again.

@sharkipelago sharkipelago deleted the python-errors branch September 1, 2022 21:21
@SSwiniarski SSwiniarski mentioned this pull request Oct 30, 2022
3 tasks
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.

4 participants