From bc5ee2b8f8c1b6a0f1e80a103ccd77febe85f8cc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Janne=20He=C3=9F?= <janne@hess.ooo>
Date: Wed, 27 Mar 2024 19:39:55 +0100
Subject: [PATCH] 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
---
 CONTRIBUTING.md                             | 12 ++++++------
 doc/build-helpers/fetchers.chapter.md       |  2 +-
 doc/languages-frameworks/agda.section.md    |  2 +-
 doc/languages-frameworks/chicken.section.md |  4 ++--
 doc/languages-frameworks/java.section.md    |  2 +-
 doc/languages-frameworks/python.section.md  |  2 +-
 6 files changed, 12 insertions(+), 12 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:
diff --git a/doc/build-helpers/fetchers.chapter.md b/doc/build-helpers/fetchers.chapter.md
index 123585c6dd2d..5c7c3257e6d4 100644
--- a/doc/build-helpers/fetchers.chapter.md
+++ b/doc/build-helpers/fetchers.chapter.md
@@ -123,7 +123,7 @@ Here is an example of `fetchDebianPatch` in action:
 buildPythonPackage rec {
   pname = "pysimplesoap";
   version = "1.16.2";
-  src = "...";
+  src = <...>;
 
   patches = [
     (fetchDebianPatch {
diff --git a/doc/languages-frameworks/agda.section.md b/doc/languages-frameworks/agda.section.md
index 51ef40267ef4..33fffc60c8db 100644
--- a/doc/languages-frameworks/agda.section.md
+++ b/doc/languages-frameworks/agda.section.md
@@ -194,7 +194,7 @@ mkDerivation {
   version = "1.5.0";
   pname = "iowa-stdlib";
 
-  src = "...";
+  src = <...>;
 
   libraryFile = "";
   libraryName = "IAL-1.3";
diff --git a/doc/languages-frameworks/chicken.section.md b/doc/languages-frameworks/chicken.section.md
index 975be5e71928..16b00b3f5b5d 100644
--- a/doc/languages-frameworks/chicken.section.md
+++ b/doc/languages-frameworks/chicken.section.md
@@ -69,12 +69,12 @@ let
       chickenEggs = super.chickenEggs.overrideScope' (eggself: eggsuper: {
         srfi-180 = eggsuper.srfi-180.overrideAttrs {
           # path to a local copy of srfi-180
-          src = "...";
+          src = <...>;
         };
       });
   });
 in
 # Here, `myChickenPackages.chickenEggs.json-rpc`, which depends on `srfi-180` will use
 # the local copy of `srfi-180`.
-"..."
+<...>
 ```
diff --git a/doc/languages-frameworks/java.section.md b/doc/languages-frameworks/java.section.md
index 2c73d428cab3..6d56ffcd4503 100644
--- a/doc/languages-frameworks/java.section.md
+++ b/doc/languages-frameworks/java.section.md
@@ -96,7 +96,7 @@ let
   something = (pkgs.something.override { jre = my_jre; });
   other = (pkgs.other.override { jre = my_jre; });
 in
-  "..."
+  <...>
 ```
 
 You can also specify what JDK your JRE should be based on, for example
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index 04303d741d67..f325af0641f6 100644
--- a/doc/languages-frameworks/python.section.md
+++ b/doc/languages-frameworks/python.section.md
@@ -1890,7 +1890,7 @@ this snippet:
 {
   myPythonPackages = python3Packages.override {
     overrides = self: super: {
-      twisted = "...";
+      twisted = <...>;
     };
   };
 }