Skip to content

TUTORIAL.md: Minor fixes. #87

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

Merged
merged 1 commit into from
Sep 23, 2022

Conversation

nlamprian
Copy link
Contributor

Thanks for all the information you shared. It's impressive work.

Copy link
Owner

@peterhinch peterhinch 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 this. It is a large PR comprising various categories of changes:

  • Spelling mistakes.
  • Code styling errors.
  • What in some cases seem to be differences of opinion re grammar and punctuation.

This makes it hard for me to review. Please could you re-submit as separate PR's addressing the different categories of changes. The spelling mistakes and incompatibilities with PEP8 clearly need to be corrected, but I may quibble over some of your other changes. Perhaps the changes in text styling could be grouped in some way.

For example I don't understand your objection to a trailing full-stop (period) in error messages.

@@ -644,7 +644,7 @@ from uasyncio import Event
async def waiter(event):
print('Waiting for event')
await event.wait() # Pause here until event is set
print('Waiter got event.')
print('Waiter got event')
Copy link
Owner

Choose a reason for hiding this comment

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

What is wrong with the '.' here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is about consistency. Most prints don't have a period.

defined, both being tasks waiting on a task or `awaitable` object. This example
comes from the `Lock` class:
```python
async def __aenter__(self):
await self.acquire() # a coro defined with async def
Copy link
Owner

Choose a reason for hiding this comment

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

The indentation here was deliberate: as a bound method it would normally be indented.

@nlamprian nlamprian force-pushed the nlamprian/fix_tutorial branch from d6a25bd to a09e88f Compare September 20, 2022 18:28
@nlamprian
Copy link
Contributor Author

I kept the text changes here (in general, these changes are what I considered would make it easier for me to read the text).

Regarding the grammar and punctuation, is it really a matter of opinion? To me (and grammarly), those commas seem necessary. If that's not the case, let me know, and I'll remove them.

Copy link
Owner

@peterhinch peterhinch left a comment

Choose a reason for hiding this comment

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

I'm willing to go with this but I'd like your view on my line comment.

@nlamprian nlamprian force-pushed the nlamprian/fix_tutorial branch from a09e88f to 92804fe Compare September 22, 2022 21:11
@peterhinch peterhinch merged commit df90862 into peterhinch:master Sep 23, 2022
@peterhinch
Copy link
Owner

Thank you.

@nlamprian nlamprian deleted the nlamprian/fix_tutorial branch September 25, 2022 18:40
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.

2 participants