summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--API.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/API.md b/API.md
index dc630d8..9f450fd 100644
--- a/API.md
+++ b/API.md
@@ -49,8 +49,10 @@ data.
* `id`: Unique category identifier as a string
* `def`: Definition table, it has the following fields:
* `name`: Category name to be shown in the interface
- * `description`: Short description (100 characters max. recommended)
- of the category (optional), will be shown as tooltip
+ * `description`: (optional) Short description of the category,
+ will be shown as tooltip. Recommended style (in English):
+ First letter capitalized, no puncation at end of sentence,
+ max. 100 characters
* `build_formspec`: The template function. Takes entry data as its
only parameter (has the data type of the entry data) and must
return a formspec which is inserted in the Entry tab.