Re: oeg-add-note and double backslash ?

[Ihor Radchenko <yantar92@posteo.net>]

David Masterson <dsmasterson@gmail.com> writes:

>> We do document the line breaks in
>> https://orgmode.org/manual/Paragraphs.html
>
> The only thing I see with respect to '\\' is:
>
>   Paragraphs are separated by at least one empty line.  If you need to
>   enforce a line break within a paragraph, use ‘\\’ at the end of a line.
>
> Which doesn't answer the question of why org-add-note (etc) added it the
> end of the first line of a Note which lead to my confusion. It's easy to
> assume, if Org is adding '\\' to the first line of the Note and the Note
> is a unit, then this is there to prevent folding/wrapping in the Note
> when Org does "something" (but what?).

Line break is a "forced" break of a line in paragraph. When there is a
line break, paragraph does not re-flow to the page width.

Re-flow may imply different things, including `fill-region' command in
Emacs or paragraph layout during export.

The detailed reason why we use this particular markup is that
otherwise some internal code assumptions inside Org mode may break when
users run `fill-region' on the notes. This is an internal implementation
detail which should not be explained in the manual.

What we might explain better is what is a line break, although I am not
very sure what to explain here - I may be too familiar with the concept
from my LaTeX-foo.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>