From 7ee00c13365d1591613589860d12bc459c212806 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Wed, 3 Aug 2016 22:40:33 +0200 Subject: cat desc styleguide --- API.md | 6 ++++-- 1 file 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. -- cgit v1.2.3