Skip to content

doc string: list item can't have more than one paragraph? #58514

@nsajko

Description

@nsajko
Contributor

Regressed after v1.5. See also: #16003.

On v1.5 the second paragraph is slightly misaligned, excessively outdented by a single character:

julia> """
           foobar(x)
 
       List:
 
       * Outer item.
 
           * First paragraph of inner item.
 
             Second paragraph of inner item.
       """
       function foobar end
foobar
 
help?> foobar
search: foobar
 
  foobar(x)
 
  List:
 
    •    Outer item.
      
          •    First paragraph of inner item.
            
              Second paragraph of inner item.

On v1.13, the alignment is completely wrong, with the second paragraph seemingly being parsed as part of the outer item:

julia> """
           foobar(x)
 
       List:
 
       * Outer item.
 
           * First paragraph of inner item.
 
             Second paragraph of inner item.
       """
       function foobar end
foobar
 
help?> foobar
search: foobar float for foldr floor global
 
  foobar(x)
 
  List:
 
    •  Outer item.
       
       •  First paragraph of inner item.
       
       Second paragraph of inner item.

Activity

added theissue type on May 23, 2025
nsajko

nsajko commented on May 23, 2025

@nsajko
ContributorAuthor

The above Markdown here on Github:

    foobar(x)
 
List:
 
* Outer item.
 
    * First paragraph of inner item.
 
      Second paragraph of inner item.
foobar(x)

List:

  • Outer item.

    • First paragraph of inner item.

      Second paragraph of inner item.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @nsajko

        Issue actions

          doc string: list item can't have more than one paragraph? · Issue #58514 · JuliaLang/julia