about summary refs log tree commit diff
path: root/doc
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 /doc
parentfcc95ff8172cc68a0d2d52aa1e8ef2120d2904ec (diff)
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 'doc')
-rw-r--r--doc/build-helpers/fetchers.chapter.md2
-rw-r--r--doc/languages-frameworks/agda.section.md2
-rw-r--r--doc/languages-frameworks/chicken.section.md4
-rw-r--r--doc/languages-frameworks/java.section.md2
-rw-r--r--doc/languages-frameworks/python.section.md2
5 files changed, 6 insertions, 6 deletions
diff --git a/doc/build-helpers/fetchers.chapter.md b/doc/build-helpers/fetchers.chapter.md
index 123585c6dd2da..5c7c3257e6d4b 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 51ef40267ef48..33fffc60c8db3 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 975be5e719281..16b00b3f5b5db 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 2c73d428cab33..6d56ffcd45039 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 04303d741d670..f325af0641f68 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 = <...>;
     };
   };
 }