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.

Sign up for GitHub

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

Jump to bottom

Add a linebreak between contract and the documentation in the doc output #1520

Merged
merged 2 commits into from
Aug 9, 2023
Merged

Add a linebreak between contract and the documentation in the doc output #1520

merged 2 commits into from
Aug 9, 2023

Commits on Aug 9, 2023

  1. Add a linebreak between contract and the documentation in the doc output 

    The markdown output of `nickel doc` for record fields with both a
contract and a documentation currently looks like

```markdown
- `foo | Dyn`
documentation
```

which in strict markdown is equivalent to

```markdown
- `foo | Dyn` documentation
```

and isn't really nice once converted to Html.

Change that to

```markdown
- `foo | Dyn`
\
documentation
```

which renders `documentation` on a newline (still whithin the same
bullet point though)
    @thufschmitt
    thufschmitt committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    5f03870 View commit details
    Browse the repository at this point in the history

  2. Accept new snapshots

    @vkleen
    vkleen committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    fb894b3 View commit details
    Browse the repository at this point in the history