Automated rfc145 migration for comments into doc-comments

NixOS · Apr 2, 2024 · 358c247 · 358c247
1 parent 4c2f2f1
commit 358c247
Show file tree

Hide file tree

Showing 944 changed files with 18,249 additions and 10,709 deletions.
diff --git a/flake.nix b/flake.nix
@@ -91,16 +91,23 @@
       nixosModules = {
         notDetected = ./nixos/modules/installer/scan/not-detected.nix;
 
-        /*
+        /**
           Make the `nixpkgs.*` configuration read-only. Guarantees that `pkgs`
           is the way you initialize it.
 
-          Example:
 
-              {
-                imports = [ nixpkgs.nixosModules.readOnlyPkgs ];
-                nixpkgs.pkgs = nixpkgs.legacyPackages.x86_64-linux;
-              }
+          # Examples
+          :::{.example}
+          ## `readOnlyPkgs` usage example
+
+          ```nix
+          {
+            imports = [ nixpkgs.nixosModules.readOnlyPkgs ];
+            nixpkgs.pkgs = nixpkgs.legacyPackages.x86_64-linux;
+          }
+          ```
+
+          :::
         */
         readOnlyPkgs = ./nixos/modules/misc/nixpkgs/read-only.nix;
       };