Semantic line breaks/linefeeds sounds good, breaking on ideas (and punctuation and RST/MD syntax), like in Brandon’s example. When I re-wrap text in Python docs and PEPs, I’m sad about making the diff unreadable. Personally, I find this style of line wrapping much more natural. There’s also a sembr “standard” (which I find a bit too nitpicky TBH). If you’re not familiar with semantic line breaks, check out Brandon Rhodes’ short post (which includes an even shorter quote from 1974!). Its the standard for the AsciiDoc docs format and some others. One Sentence Per Line (aka semantic line breaks) is an increasingly popular convention for prose like this (its been used for years in most of the reST/myST, website and docs-related repos I’m involved in, as well as on most others for Readmes, Contributing Guides, etc. I added the summary above click for the original recently wrote in a PEP editing issue: [edit: this post originally started with a quote about one sentence per line, which led some people in the wrong direction. The advantage is that editing a few wordsĭoesn't cause the whole paragraph to reflow. There's still a *maximum* line length, but lines are broken before that. (or commas, semicolons, semantic pauses). In formats like ReST, Markdown or HTML, which allow arbitrary line wrapping. Word-wrapping paragraphs at (say) the 79th column Should we allow/encourage semantic line breaks for newly written prose (docs, PEPs, etc.)? Semantic line breaks are an alternative to
0 Comments
Leave a Reply. |