#2349·fabric

Starting sentences with class names immdiately after ending a sentence with a method name

Author: gabkdllyCreated Oct 28, 2025Updated Aug 10, 2026
LabelsDocsNeeds patchLow-hanging fruit

In the documentation here: https://docs.fabfile.org/en/latest/getting-started.html#run-commands-via-connections-and-run in the second paragraph, one sentence ends with "run.", and the next sentence begins with "Connection". Like this: "... run. Connection ..." This makes it look like the run method has an attribute/method named Connection, which was confusing to me upon first reading. Evoking confusion in your reader can be a good thing, as it slows them down, which can be good for comprehension. However, this needs also to be balanced with clarity and ease of reading and comprehension. You might consider restructuring this sentence, so that run does not come at the end. You might end it with "... such as the run function. Connection ..." I hope this helps.