History

FireFly eca8bce081 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`		2024-05-15 15:24:03 -07:00
..
src	lix-doc: don't chomp bold headings off	2024-05-15 15:24:03 -07:00
.gitignore	nix-doc -> lix-doc, make self-contained in package.nix	2024-04-08 04:05:13 +00:00
Cargo.lock	nix-doc -> lix-doc, make self-contained in package.nix	2024-04-08 04:05:13 +00:00
Cargo.toml	nix-doc -> lix-doc, make self-contained in package.nix	2024-04-08 04:05:13 +00:00
package.nix	Format Nix code with `nixfmt`	2024-04-08 13:00:00 -07:00
README.md	nix-doc -> lix-doc, make self-contained in package.nix	2024-04-08 04:05:13 +00:00

README.md

lix-doc

This is a stripped down fork of nix-doc, used for :doc in nix repl in Lix. It will be replaced in the future with proper support when we get the new parser working, but it exists today as a low-risk implementation of an important usability feature.