about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorNaïm Favier <n@monade.li>2022-08-29 14:06:56 +0200
committerNaïm Favier <n@monade.li>2022-08-29 20:19:34 +0200
commit2f88279ab9486518879e5a8f9f9e96d3559b14a7 (patch)
tree5e5576eb59d6410a97316a18148609e1cab2606d /doc
parentc83b87fecd1a86d6a1861667664e6f45eb76d763 (diff)
doc: specify that `longDescription` should be Markdown
In the spirit of RFC 72, document that longDescription is in CommonMark.
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv/meta.chapter.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md
index 475006b1259b6..51ad29b4b16ec 100644
--- a/doc/stdenv/meta.chapter.md
+++ b/doc/stdenv/meta.chapter.md
@@ -80,7 +80,7 @@ Right: `"A library for decoding PNG images"`
 
 ### `longDescription` {#var-meta-longDescription}
 
-An arbitrarily long description of the package.
+An arbitrarily long description of the package in [CommonMark](https://commonmark.org) Markdown.
 
 ### `branch` {#var-meta-branch}