Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiline function attribute argument docs render incorrectly #75

Closed
infinisil opened this issue Sep 14, 2023 · 0 comments · Fixed by #81
Closed

Multiline function attribute argument docs render incorrectly #75

infinisil opened this issue Sep 14, 2023 · 0 comments · Fixed by #81

Comments

@infinisil
Copy link
Collaborator

infinisil commented Sep 14, 2023

This file:

{
  /* Some description */
  f =
    {
      /*
      First line

      Second line
      */
      x,
    }: x;
}

Produces this markdown:

Some description

structured function argument

: `x`

  : First line

        Second line

The second line is indented too much, rendering it as code (only because of the spacing between the lines).

In Nixpkgs I had to unident the entire second paragraph as a workaround: https://github.com/NixOS/nixpkgs/blob/08f615eb1b3c5cf7481996f29c6092c7c891b15b/lib/fileset/default.nix#L72-L76

This could probably use the same fix as in #62

@infinisil infinisil changed the title Paragraphs in function attribute argument docs render incorrectly Multiline function attribute argument docs render incorrectly Sep 15, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
asymmetric added a commit that referenced this issue Sep 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant