From 2c3cc06a1da5d1d8f31f204bbd00291349bc05e1 Mon Sep 17 00:00:00 2001 From: Bill Ferguson Date: Tue, 28 Dec 2021 20:38:21 -0500 Subject: [PATCH] [dtutils/deprecated] Documented deprecated function added to dtutuils --- .../dtutils/deprecated.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 content/lua.scripts.api.manual/dtutils/deprecated.md diff --git a/content/lua.scripts.api.manual/dtutils/deprecated.md b/content/lua.scripts.api.manual/dtutils/deprecated.md new file mode 100644 index 0000000..20c05fc --- /dev/null +++ b/content/lua.scripts.api.manual/dtutils/deprecated.md @@ -0,0 +1,29 @@ +--- +title: deprecated +id: deprecated +weight: 32 +draft: false +author: "people" +--- + +## NAME + +deprecated + +## SYNOPSIS + +warn that a script is deprecated + +## USAGE +``` +local du = require "lib/dtutils" +du.deprecated(script_name, deprecation_time) +``` +**script_name** - _string_ - the name of the script, i.e. "contrib/clear_GPS" +**deprecation_time** - _string_ - when the script will be removed, i.e. "darktable release 4.0" + +## DESCRIPTION + +**deprecated** gives users a warning that a script is outdated or no longer useful and will be +removed at the specified time +