python-intermediate-development icon indicating copy to clipboard operation
python-intermediate-development copied to clipboard

Confirm guidance on Semantic Line Breaks

Open amangoel185 opened this issue 6 months ago • 2 comments

  • The current recommendation for Line Length in the Workbench Style Guide is to use Semantic Line Breaks with a maximum of 100 characters per line
  • However, recent conversation within The Carpentries have pointed that Semantic Line Breaks make it difficult for translation of a lesson
  • Also relate's to @douglowe comment
  • We should confirm the official guidance and format the lesson accordingly

amangoel185 avatar Jul 22 '25 10:07 amangoel185

  • The Style Guide has since been updated to not recommend semantic line breaks anymore
  • The updated guidelines now recommend "writing one complete sentence per line" so we can update the lesson accordingly

amangoel185 avatar Aug 26 '25 07:08 amangoel185

Also related and raised in #437. Good to know this is now formally in the Style Guide. I would recommend we explicitly state somewhere that we use the Carpentries Style Guide and link to that. Anything that isn't stated in the Style Guide that we would like to enforce, we should see if it can be put in something like markdownlint.

bielsnohr avatar Sep 23 '25 13:09 bielsnohr