Revise episodes 1 through 9 for readability #13
Conversation
Linguistic interventions to improve readability, while affecting the current meanings as little as possible.
introduction.md: readability pass 1
It makes it so much more readable and improvable
Enforce consistent (not necessarily correct) punctuation. Apply occasional edits.
introduction.md: incorporate edits for readability
🆗 Pre-flight checks passed 😃This pull request has been checked and contains no modified workflow files or spoofing. It should be safe to Approve and Run the workflows that need maintainer approval. |
Linguistic interventions to improve readability, affecting the current meanings as little as possible.
benchmarking.md: readability pass 1
wmotion
changed the title
computing-pi.md: readability pass 1
wmotion
changed the title
threads-and-processes.md: readability pass 1
wmotion
changed the title
wmotion
changed the title
wmotion
changed the title
wmotion
changed the title
wmotion
changed the title
|
This comment marks the end of the first round of checks for readability. |
|
This comment marks the end of the second round of checks for readability. The sentences should be less conversational and tighter now, hence easier to read through. During the revision I kept in mind common-sense practices in scientific writing (and time efficiency). I restricted myself to textual clarity. As for the content, the depth, breadth and position of topics are unchanged. I did not evaluate the correctness and consistency of content and the pedagogy of the exposition. Hopefully, the current edits can serve well enough for the coming edition of In general, I aimed to have each commit deal with changes in a single md file. The diffs of all nine files affected by this PR are at https://github.com/esciencecenter-digital-skills/parallel-python-workbench/pull/13/files Hope this helps. |
See help(memory_usage) for the memory being measured in MiB.
Fill gaps. Fix NameError with variable `high`.
Incorporate changes from the source repository
|
@jhidding |
Default behaviour of Numba left to further considerations.
This PR contains various edits to improve the reading experience: for example, more active verb forms, fewer antecedent/consequent pairs. The correctness/appropriateness of the words is left out of discussion here, hence I tried not to alter that.
@jhidding In this revision of introduction.md, each sentence takes a new line. If this makes reviewing the merge cumbersome, I can split the PRs into one that contains edits in the original line layout; and into a following one that only breaks lines, once a final(ish) text has been agreed.