about summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJanne Heß <janne@hess.ooo>2024-03-27 19:39:55 +0100
committerValentin Gagarin <valentin.gagarin@tweag.io>2024-03-28 09:28:12 +0100
commitbc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc (patch)
treebdb2ed01fa20d298091e01a08029b556a2c95872 /CONTRIBUTING.md
parentfcc95ff8172cc68a0d2d52aa1e8ef2120d2904ec (diff)
downloadnixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.tar
nixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.tar.gz
nixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.tar.bz2
nixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.tar.lz
nixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.tar.xz
nixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.tar.zst
nixlib-bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc.zip
treewide: Switch markdown placeholder from "..." to <...>
We use angle brackets since they look a lot like a placeholder while
also being valid nix code, as suggested by roberth here: https://github.com/NixOS/nixpkgs/pull/299554#discussion_r1541797970
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 699115d95378..4b1a12362f39 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -557,7 +557,7 @@ Names of files and directories should be in lowercase, with dashes between words
 
   ```nix
   foo {
-    arg = "...";
+    arg = <...>;
   }
   ```
 
@@ -566,14 +566,14 @@ Names of files and directories should be in lowercase, with dashes between words
   ```nix
   foo
   {
-    arg = "...";
+    arg = <...>;
   }
   ```
 
   Also fine is
 
   ```nix
-  foo { arg = "..."; }
+  foo { arg = <...>; }
   ```
 
   if it's a short call.
@@ -683,19 +683,19 @@ Names of files and directories should be in lowercase, with dashes between words
 - Functions should list their expected arguments as precisely as possible. That is, write
 
   ```nix
-  { stdenv, fetchurl, perl }: "..."
+  { stdenv, fetchurl, perl }: <...>
   ```
 
   instead of
 
   ```nix
-  args: with args; "..."
+  args: with args; <...>
   ```
 
   or
 
   ```nix
-  { stdenv, fetchurl, perl, ... }: "..."
+  { stdenv, fetchurl, perl, ... }: <...>
   ```
 
   For functions that are truly generic in the number of arguments (such as wrappers around `mkDerivation`) that have some required arguments, you should write them using an `@`-pattern: