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

Write documentation for zip & enumerate #37

Merged
merged 8 commits into from
Sep 10, 2022
Merged

Write documentation for zip & enumerate #37

merged 8 commits into from
Sep 10, 2022

Conversation

tusharkhatriofficial
Copy link
Contributor

Added a link referring to a new detailed file about zip and enumerate functions in Trey Hunner: zip and enumerate

Copy link
Owner

@Akuli Akuli left a comment

Choose a reason for hiding this comment

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

Thanks, this looks promising!

A few thoughts:

  • Just put everything into the existing trey-hunner-zip-and-enumerate.md file: having two files for the same thing doesn't make much sense. I can rename the file once we're otherwise done, or you can rename it if you want. Feel free to delete anything that is no longer needed.
  • Use the >>> prompt for examples as in the rest of this tutorial.
  • Try to keep your english usage simple: something like "The keen-eyed amongst you might ask what if" should be replaced with e.g. "Let's see what happens if". Basically, imagine that people reading this are not good at english. The focus should be in learning how Python behaves, not wondering what "keen-eyed amongst" means.

@tusharkhatriofficial
Copy link
Contributor Author

Got it.. do you want me to add it at the beginning of trey-hunner-zip-and-enumerate.md or at the end?

@Akuli
Copy link
Owner

Akuli commented Sep 6, 2022

Probably to the end. That's where it currently links to the article from treyhunner.com that this PR is supposed to replace. Before that, it explains how the for first, second in ... syntax works, which is needed for both zip and enumerate.

@tusharkhatriofficial
Copy link
Contributor Author

Please review

Copy link
Owner

@Akuli Akuli left a comment

Choose a reason for hiding this comment

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

It's making progress :)

@tusharkhatriofficial
Copy link
Contributor Author

Do you want me to squash the commits?

@Akuli
Copy link
Owner

Akuli commented Sep 7, 2022

You don't need to squash. I will squash when merging.

Copy link
Owner

@Akuli Akuli left a comment

Choose a reason for hiding this comment

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

It's becoming pretty good :)

I'm quite nit-picky in these reviews, because I really want the tutorial to be as simple as possible to follow. I basically look at this from a beginner's point of view, so things that seem easy to an experienced programmer like you often need to be explained :)

Copy link
Owner

@Akuli Akuli left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! I think this will be the last or second-to-last round of reviewing :)

Copy link
Owner

@Akuli Akuli left a comment

Choose a reason for hiding this comment

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

Thanks! I did a few more edits and renamed the file.

@Akuli Akuli merged commit 0e00c85 into Akuli:master Sep 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants