summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2010-11-01 10:49:38 +0100
committerSebastien Helleu <flashcode@flashtux.org>2010-11-01 10:49:38 +0100
commitb3365a7a71eba9e83a295eefff815b42d24fb0fb (patch)
tree029c3a9a7e7ff2be04e0ce148736f0fabb032eaa /doc/en
parent60c1b6ea8390b773d1285aab671912c1cd46c9a0 (diff)
downloadweechat-b3365a7a71eba9e83a295eefff815b42d24fb0fb.zip
Fix return code values in plugin API reference for some config callbacks
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_plugin_api.en.txt15
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index 512823c21..ff6add99e 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -3464,7 +3464,10 @@ my_section_read_cb (void *data, struct t_config_file *config_file,
{
/* ... */
- return WEECHAT_RC_OK;
+ return WEECHAT_CONFIG_OPTION_SET_OK_CHANGED;
+ /* return WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE; */
+ /* return WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND; */
+ /* return WEECHAT_CONFIG_OPTION_SET_ERROR; */
}
int
@@ -3544,7 +3547,10 @@ section = weechat.config_new_section(config_file, name,
# example
def my_section_read_cb(data, config_file, section, option_name, value):
# ...
- return weechat.WEECHAT_RC_OK
+ return weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND
+ # return weechat.WEECHAT_CONFIG_OPTION_SET_ERROR
def my_section_write_cb(data, config_file, section_name):
# ...
@@ -3772,15 +3778,14 @@ option = weechat.config_new_option(config_file, section, name, type, description
# example
def option4_check_value_cb(data, option, value):
# ...
- return weechat.WEECHAT_RC_OK
+ return 1
+ # return 0
def option4_change_cb(data, option):
# ...
- return weechat.WEECHAT_RC_OK
def option4_delete_cb(data, option):
# ...
- return weechat.WEECHAT_RC_OK
option1 = weechat.config_new_option(config_file, section, "option1", "boolean",
"My option, type boolean",