chore(build): auto-generate docs

max397574 · Sep 13, 2024 · 0ce4122 · 0ce4122
1 parent 04fce05
commit 0ce4122
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 6 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -404,7 +404,13 @@ Index of the entry in the completion menu
 
 Whether the item is marked as deprecated by the source or not
 
-## Source
-`format_data.source string`
+## Source Name
+`format_data.source_name string`
 
-The name of the source from which the entry was completed
+The name of the source from which the entry was completed
+
+## Source Display Name
+`format_data.source_display_name string`
+
+The display name of the source from which the entry was completed which
+is more detailed than the normal name
diff --git a/docs/configuration_recipes.md b/docs/configuration_recipes.md
@@ -11,9 +11,12 @@ Here are some useful configurations for care.
 
 This section lists some commonly uses fields in which users might be interested.
 
--   `data.source`: You can access the name of the source form which the entry
-    was completed with the `source` field in the
-    [additional data](/config/#source) passed to the `format_entry` function.
+### Source name
+
+You can access the name of the source form which the entry was completed with
+the `source_name` or the `source_display_name` field in the additional data
+passed to the `format_entry` function. The display name will often be
+significantly longer so it's recommended to use `source_name`.
 
 ## Labels and shortcuts