aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Gnome-module.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/markdown/Gnome-module.md')
-rw-r--r--docs/markdown/Gnome-module.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md
index 9477b29..ccdb1f2 100644
--- a/docs/markdown/Gnome-module.md
+++ b/docs/markdown/Gnome-module.md
@@ -298,9 +298,23 @@ VAPI or Vala binaries.
### gnome.yelp()
+```meson
+ gnome.yelp(id: string, sources: ...string, sources: []string, media: []string,
+ languages: []string, symlink_media: bool = true): void
+```
+
Installs help documentation using Yelp. The first argument is the
project id.
+Additionally, sources can be passed as additional positional arguments. This
+was, however, undocumented and never officially supported. Due to a longstanding
+bug, passing sources as a keyword argument will result in the positional
+argument sources to be ignored. *since 0.60.0* A warning is raised in this case.
+
+*Since 0.60.0* the use of the positional argument sources has been deprecated,
+and the "sources" keyword argument should be used instead. The passing of
+sources as positional arguments will be removed in the future.
+
This also creates two targets for translations
`help-$project-update-po` and `help-$project-pot`.