TUTORIAL.md: Minor fixes. #87
Conversation
There was a problem hiding this comment.
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.
v3/docs/TUTORIAL.md
Outdated
| @@ -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') | |||
There was a problem hiding this comment.
What is wrong with the '.' here?
There was a problem hiding this comment.
This is about consistency. Most prints don't have a period.
v3/docs/TUTORIAL.md
Outdated
| 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 |
There was a problem hiding this comment.
The indentation here was deliberate: as a bound method it would normally be indented.
nlamprian
force-pushed
the
nlamprian/fix_tutorial
branch
from
d6a25bd to
a09e88f
Compare
|
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. |
nlamprian
force-pushed
the
nlamprian/fix_tutorial
branch
from
a09e88f to
92804fe
Compare
|
Thank you. |
Thanks for all the information you shared. It's impressive work.