diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2021-06-06 13:17:54 +0200 |
---|---|---|
committer | Jan Tojnar <jtojnar@gmail.com> | 2021-06-07 06:34:59 +0200 |
commit | 3c78ad2561a831dcbe6e193465f787019638d56b (patch) | |
tree | a25b53f1a3f821f714bf0f11e1c5ae8939ac1c4e /doc/contributing/coding-conventions.chapter.md | |
parent | adecb00f5a07ce3f5cc97e7ccf5d814f70f6704f (diff) | |
download | nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.gz nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.bz2 nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.lz nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.xz nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.zst nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.zip |
doc: Use markdown syntax for xrefs
Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
Diffstat (limited to 'doc/contributing/coding-conventions.chapter.md')
-rw-r--r-- | doc/contributing/coding-conventions.chapter.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/contributing/coding-conventions.chapter.md b/doc/contributing/coding-conventions.chapter.md index 4fa88895484..e42ba512b98 100644 --- a/doc/contributing/coding-conventions.chapter.md +++ b/doc/contributing/coding-conventions.chapter.md @@ -6,7 +6,7 @@ - Do not use tab characters, i.e. configure your editor to use soft tabs. For instance, use `(setq-default indent-tabs-mode nil)` in Emacs. Everybody has different tab settings so it’s asking for trouble. -- Use `lowerCamelCase` for variable names, not `UpperCamelCase`. Note, this rule does not apply to package attribute names, which instead follow the rules in <xref linkend="sec-package-naming"/>. +- Use `lowerCamelCase` for variable names, not `UpperCamelCase`. Note, this rule does not apply to package attribute names, which instead follow the rules in [](#sec-package-naming). - Function calls with attribute set arguments are written as @@ -209,7 +209,7 @@ There are a few naming guidelines: - Dashes in the package name _should_ be preserved in new variable names, rather than converted to underscores or camel cased — e.g., `http-parser` instead of `http_parser` or `httpParser`. The hyphenated style is preferred in all three package names. -- If there are multiple versions of a package, this _should_ be reflected in the variable names in `all-packages.nix`, e.g. `json-c-0-9` and `json-c-0-11`. If there is an obvious “default” version, make an attribute like `json-c = json-c-0-9;`. See also <xref linkend="sec-versioning" /> +- If there are multiple versions of a package, this _should_ be reflected in the variable names in `all-packages.nix`, e.g. `json-c-0-9` and `json-c-0-11`. If there is an obvious “default” version, make an attribute like `json-c = json-c-0-9;`. See also [](#sec-versioning) ## File naming and organisation {#sec-organisation} |