diff options
| author | Dylan Baker <dylan@pnwbakers.com> | 2021-10-05 12:40:22 -0700 |
|---|---|---|
| committer | Dylan Baker <dylan@pnwbakers.com> | 2021-10-07 09:26:35 -0700 |
| commit | bcfbfbb343cc8ebe415fce042f5d0b1a1c488f69 (patch) | |
| tree | b23e076a4a67cb97b4a83b44a8826e77cd6a6468 /docs | |
| parent | dfec4385a74fb0530733d008bd2afce278bc486e (diff) | |
| download | meson-bcfbfbb343cc8ebe415fce042f5d0b1a1c488f69.tar.gz | |
modules/gnome: deprecate yelp variadic sources
Yelp currently can take sources two different ways, the first is via
variadic arguments, the second is by a keyword argument. If the keyword
is passed then the variadic arguments are silently ignored, which is
obviously not ideal. Fortunately the variadic form was never documented,
and is likely not in wide use.
This patch fixes it by deprecating the variadic form, and warning if
both are passed. It does not change behavior as someone may be relying
on it.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Gnome-module.md | 14 | ||||
| -rw-r--r-- | docs/markdown/snippets/gnome_yelp_sources.md | 6 |
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md index 9477b292c..ccdb1f2b2 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`. diff --git a/docs/markdown/snippets/gnome_yelp_sources.md b/docs/markdown/snippets/gnome_yelp_sources.md new file mode 100644 index 000000000..3633d17ea --- /dev/null +++ b/docs/markdown/snippets/gnome_yelp_sources.md @@ -0,0 +1,6 @@ +## gnome.yelp variadic argument deprecation + +`gnome.yelp` previously allowed sources to be passed either as variadic +arguments or as a keyword argument. If the keyword argument was given the +variadic arguments would be silently ignored. This has changed in 0.60.0, the +variadic form has been deprecated, and a warning is printed if both are given. |