Skip to content

Why are newlines replaced with spaces in function docstrings? #526

@moneylobster

Description

@moneylobster

CCL displays multiline docstrings in a single line when describe is called (but not when documentation is called). Since the usual method of looking at function documentation via C-c C-d in Sly (and SLIME as far as I can tell) displays the output of describe, when I'm looking at the documentation for a function I see it on a single line.

The line responsible for this seems to be here:

https://github.com/Clozure/ccl/blob/master/lib/describe.lisp#L1248

It's nothing crucial since I can just jump to the definition of the functions and read the formatted docstrings there (and as far as I can tell nothing about this is specified in the standard anyway) but I wanted to ask out of curiosity whether there was a reason for the substitution? Compactness of output maybe?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions