Hi Tobias, Hi Lauren,<br>
<br>
> I put linebreaks there because I want them exactly there :)<br>
<br>
But then you are talking more about paragraphs rather than linebreaks, aren't you? :-)<br>
<br>
A comment like this is totally fine to me:<br>
<br>
<b>terminate</b><font color="#000000"> <br>
</font> <font color="#000000"> </font><font color="#008080">"Stop the receiver forever.<br>
</font> <font color="#008080"> Run all unwind contexts (#ensure:/#ifCurtailed: blocks) on the stack, even if they are currently in progress. If already active unwind contexts should not be continued, send #terminateAggressively instead.<br>
</font> <font color="#008080"> NOTE THAT bla bla bla!"</font><br>
<br>
But not this:<br>
<br>
<b>terminate</b><font color="#000000"> <br>
</font> <font color="#000000"> </font><font color="#008080">"Stop the receiver forever.<br>
</font> <font color="#008080"> Run all unwind contexts (#ensure:/#ifCurtailed: blocks)<br>
on the stack, even if they are currently in progress. If<br>
already active unwind contexts should not be continued,<br>
send #terminateAggressively instead.<br>
</font> <font color="#008080"> NOTE THAT bla bla bla!"</font><br>
<br>
In the second example, we would just stupidically do the work of the text composer. Similar to the "tabs vs spaces" debate, spaces/manual linebreaks prescribe the appearance of the code/text, whereas tabs/automatic line-breaking leave this decision to the tooling of the reader or author. If I resize my browser window, I would like its contents to be re-layouted as flexibly as possible.<br>
<br>
Even worse, manual linebreaks blur the differences between semantically distinct paragraphs and composition-specific linebreaks.<br>
<br>
@Lauren:<br>
<br>
> My proposal is to not include the documentation in a comment at all.<br>
<br>
I think you are neglecting comments in the midst of any method, which occur pretty frequently in Squeak and are an important part of Smalltalk programming IMHO. :)<br>
<br>
Best,<br>
Christoph<br>
<br>
<font color="#808080">---<br>
</font><font color="#808080"><i>Sent from </i></font><font color="#808080"><i><a href="https://github.com/hpi-swa-lab/squeak-inbox-talk"><u><font color="#808080">Squeak Inbox Talk</font></u></a></i></font><br>
<br>
On 2022-04-01T16:06:01+00:00, drurowin@gmail.com wrote:<br>
<br>
> Hi Christoph, Marcel, Tobias,<br>
> <br>
> My proposal is to not include the documentation in a comment at all.<br>
> <br>
> Add a dedicated text box to the browser for the comment and treat method<br>
> comments like class comments, but then display both code and<br>
> documentation simultaneously side by side. Then there could be<br>
> completely different rules for formatting text from formatting code. I<br>
> want each text line to be narrow... but I want each code line to be able<br>
> to be wide to take advantage of indentation.<br>
> <br>
> On 4/1/22 11:42, christoph.thiede at student.hpi.uni-potsdam.de wrote:<br>
> >> How about email's format=flowed?<br>
> > <br>
> > A problem with this could be that some systems do not preserve trailing spaces. For instance, they do not appear in the mailing list archive. :-)<br>
> Unrelated, I checked my copy of the sent mail and it looks like my<br>
> client stripped the trailing spaces when it got sent to prepare it for<br>
> the ml archive.<br>
> <br>
> This might be a problem with the inlined diffs that get sent out when<br>
> people save new versions, but I still think it's the least intrusive<br>
> option and doesn't require any special non-space-bar spaces. It<br>
> wouldn't affect code samples in the comments, and you could detect<br>
> paragraphs all on one literal line by the period-return-return and<br>
> period-endOfComment patterns.<br>
> <br>
> If you press return you get a normal line break (for people like Tobias<br>
> and myself, who put in line breaks because they're supposed to be<br>
> there), and if you hit the space bar right before that it signals the<br>
> comment formatting engine to use the user's preference to change the<br>
> line widths.<br>
> <br>
>