Re: Doc-string with newline character

[David Kastrup]

Thomas Morley <thomasmorley65@gmail.com> writes:

> Am Mi., 30. Dez. 2020 um 10:37 Uhr schrieb Jonas Hahnfeld <hahnjo@hahnjo.de>:
>>
>> Hi,
>>
>> Am Mittwoch, dem 30.12.2020 um 10:31 +0100 schrieb Thomas Morley:
>> > Hi,
>> >
>> > while preparing a patch a noticed a problem with a doc-string:
>> > I want to refer to newline characters and wrote "@code{#\newline}",
>> > but it comes out as
>> > # ewline
>> > for both pdf and html.
>> > I couldn't figure how to let print
>> > #\newline
>> >
>> > Any hint?
>>
>> I didn't try, but I could imagine that you need to escape the backslash
>> so it's not expanded when parsing the string, like so:
>>     @code{#\\newline}
>>
>> Does this help?
>>
>> Jonas
>
> @code{#\\newline} did the trick already (I thought I had checked this...)
> Patch is now up
> https://gitlab.com/lilypond/lilypond/-/merge_requests/581
>
> Though, there is a further question.
> The patch aims at introducing a new markup-list-command. Thus the
> doc-string is taken for
> NR A.12 Text markup list commands
> This now looks as attached.
>
> I'd love to see there
> "
> Used properties
> - split-char (#\newline)
> "
>
> Any chance?
>
> Thanks,
>   Harm
>
>
>

It's probably a bug.  Try replacing in

                                    (format #f "@item @code{~a} (~a)\n"

in the function doc-markup-function-properties in
scm/document-markup.scm the second ~a with ~s (which should quote
everything in read syntax).  This would likely have more consequences,
like when there are string defaults.

-- 
David Kastrup