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
This commit is contained in:
Janne Heß 2024-03-27 19:39:55 +01:00 committed by Valentin Gagarin
parent fcc95ff817
commit bc5ee2b8f8
6 changed files with 12 additions and 12 deletions

View file

@ -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: