diff options
author | FireFly <firefly@firefly.nu> | 2024-05-15 15:24:03 -0700 |
---|---|---|
committer | Jade Lovelace <lix@jade.fyi> | 2024-05-15 15:24:03 -0700 |
commit | eca8bce08112a7e0621baad29a1be2fcd0c668b9 (patch) | |
tree | 7da16613c7cfa6045736313d87e58ecfc6d57579 /shell.nix | |
parent | 03655c310dccd4f6d61af262ccf886b7e3906fe4 (diff) |
lix-doc: don't chomp bold headings off
There are a few places in nixpkgs lib where `**Foo**:` is used as a heading instead of the usual markdown `# Foo` ones. I think this is intentional with how it gets rendered in the manual, e.g. [`lib.lists.sortOn`][1].
[1]: https://nixos.org/manual/nixpkgs/stable/#function-library-lib.lists.sortOn
`nix-doc` prints this as
```
*Laws**:
```nix
sortOn f == sort (p: q: f p < f q)
```
```
chomping off the first asterisk as part of `cleanup_single_line` that's meant to deal with `/** \n * \n * \n */` style doc comments. This also means the usage in lix ends up funny-looking with a trailing asterisk as if there's a footnote to pay attention to (which is how I first noticed it, heh)
The fix:
When cleaning up a single line and removing a prefix comment character,
ensure it's followed by whitespace (or the last character of the line).
Upstream-PR: https://github.com/lf-/nix-doc/pull/26
Change-Id: If2870c53a632f6bbbcca98a4bfbd72f5bef37879
Diffstat (limited to 'shell.nix')
0 files changed, 0 insertions, 0 deletions