Reword async intro for clarity
#62926
Conversation
As an intelligent reader, I had to read and re-read (and re-read) the first sentence of this document, over and over again, yet it still didn't make sense. This isn't my fault as a reader because the sentence was written so poorly. English speakers will find this flow easier to understand now. - Docs Pull Request +label: docsite_pr
ansibot
added
affects_2.10
dagwieers
added
the
docsite_pr
ansibot
removed
the
needs_triage
ansibot
added
needs_rebase
|
Thanks for working on the intro to this page @invsblduck. Your changes can't be merged cleanly now, since we merged #63056. But I've cherry-picked your commit onto my next set of User Guide changes, so you should see most of your suggestions adopted soon. |
|
@acozine No worries! Doesn't matter to me whether you use my text verbatim or not. But worth mentioning: The hangup I encountered as a new reader was misinterpretation of the word "block" in the first sentence--my brain was thinking "code block," and I just couldn't get past wondering what the author was really intending to convey. As the old programmer that I am, blocking vs. non-blocking becomes embarrassingly obvious (especially for a page about async ;-)), but the first sentence just needs a more graceful context/intro at least. Thanks! |
SUMMARY
As an intelligent reader, I had to read and re-read (and re-read) the first
sentence of this document, over and over again, yet it still didn't make sense.
This isn't my fault as a reader because the sentence was written so poorly.
English speakers will find this flow easier to understand now.
ISSUE TYPE
+label: docsite_pr
COMPONENT NAME
async
ADDITIONAL INFORMATION
n/a