diff options
| author | Lunaphied <lunaphied@lunaphied.me> | 2024-03-17 18:01:05 -0600 |
|---|---|---|
| committer | Lunaphied <lunaphied@lunaphied.me> | 2024-04-03 13:47:22 -0600 |
| commit | 7a1054fa5f223126833718fc3f332579dba5f0f7 (patch) | |
| tree | 790daae10628ec42436d79c943dcbcd8d7168fd6 /maintainers/build-release-notes.py | |
| parent | 56c7dfd65290dea957de6fad4e2df26f1630e407 (diff) | |
repl: improve `:doc` builtin repl command to support lambdas.
For a long time `nix repl` has supported displaying documentation set on
builtins, however, it has long been convention to use Markdown comments
on Nix functions themselves for documentation. This exposes that
information to `nix repl` users in a nice and formatted way.
NixOS/rfcs#145 doc-comments are primarily what this feature is intended
to consume, however, support for lambda documentation in the repl is
experimental. We do our best effort to support the RFC here.
These changes are based on [the nix-doc library](https://github.com/lf-/nix-doc) and
are licensed under the terms described in the relevant source files.
Change-Id: Ic6fe947d39a22540705d890737e336c4720b0a22
Diffstat (limited to 'maintainers/build-release-notes.py')
| -rw-r--r-- | maintainers/build-release-notes.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/maintainers/build-release-notes.py b/maintainers/build-release-notes.py index ba645d19a..00c91e5da 100644 --- a/maintainers/build-release-notes.py +++ b/maintainers/build-release-notes.py @@ -38,7 +38,7 @@ for p in paths: try: e = frontmatter.load(p) if 'synopsis' not in e.metadata: - raise Exception('missing synposis') + raise Exception('missing synopsis') unknownKeys = set(e.metadata.keys()) - set(('synopsis', 'cls', 'issues', 'prs', 'significance')) if unknownKeys: raise Exception('unknown keys', unknownKeys) |