nathan/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2026-09-28 10:50:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/readme: Clarify and format :doc REPL command

Browse Source 
Co-authored-by: Matt Sturgeon <matt@sturgeon.me.uk>
This commit is contained in:
Victor Engmark
2026-09-27 10:26:51 +02:00
parent 5b1059092b
commit b99a7f357d
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/README.md
View File

@@ -21,7 +21,12 @@ This includes getting started guides and onboarding guides for *using* Nixpkgs a
Write **guides** task-first: lead with a working example, then explain in prose.
Write **reference** as the specification of functions and attributes.
We are actively working to generate reference documentation from the [doc-comments](https://github.com/NixOS/rfcs/blob/master/rfcs/0145-doc-strings.md) present in code, which also lets you view it locally with `:doc` in `nix repl`.
We are actively working to generate reference documentation from the [doc-comments](https://github.com/NixOS/rfcs/blob/master/rfcs/0145-doc-strings.md) present in code, which also lets you view it locally with the `:doc` command in `nix repl`, e.g.:
```
nix-repl> :l <nixpkgs>
nix-repl> :doc lib.mapAttrsToList
```
See [Document structure](#document-structure) for a structural template.