Commit 8bc5aa14 8bc5aa141ac0d13a6e7bd2a3d09febe6eca32b11 by Wojciech Polak

Correct some pydocs.

1 parent 025af57c
......@@ -284,14 +284,14 @@ api_address_to_string (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "create", (PyCFunction) api_address_create, METH_VARARGS,
"Allocate and initialize ADDR by parsing the RFC822 "
"address-list STRING." },
"Allocate and initialize 'addr' by parsing the RFC822 "
"address-list 'string'." },
{ "createv", (PyCFunction) api_address_createv, METH_VARARGS,
"Allocate and initialize ADDR by parsing the RFC822 address-list." },
"Allocate and initialize 'addr' by parsing the RFC822 address-list." },
{ "destroy", (PyCFunction) api_address_destroy, METH_VARARGS,
"Destroy ADDR." },
"Destroy 'addr'." },
{ "is_group", (PyCFunction) api_address_is_group, METH_VARARGS,
"Return True if address is just the name of a group, False otherwise." },
......
......@@ -243,7 +243,7 @@ static PyMethodDef methods[] = {
"" },
{ "is_modified", (PyCFunction) api_attribute_is_modified, METH_VARARGS,
"Return TRUE or FALSE whether attribute has been modified." },
"Return True or False whether attribute has been modified." },
{ "clear_modified", (PyCFunction) api_attribute_clear_modified,
METH_VARARGS, "" },
......
......@@ -125,10 +125,10 @@ api_body_get_stream (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "size", (PyCFunction) api_body_size, METH_VARARGS,
"Retrieve BODY size." },
"Retrieve 'body' size." },
{ "lines", (PyCFunction) api_body_lines, METH_VARARGS,
"Retrieve BODY number of lines." },
"Retrieve 'body' number of lines." },
{ "get_stream", (PyCFunction) api_body_get_stream, METH_VARARGS,
"" },
......
......@@ -37,7 +37,7 @@ api_strerror (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "strerror", (PyCFunction) api_strerror, METH_VARARGS,
"Return the error message corresponding to ERR, "
"Return the error message corresponding to 'err', "
"which must be an integer value." },
{ NULL, NULL, 0, NULL }
......
......@@ -198,10 +198,10 @@ api_header_get_field_value (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "size", (PyCFunction) api_header_size, METH_VARARGS,
"Retrieve HEADER size." },
"Retrieve 'header' size." },
{ "lines", (PyCFunction) api_header_lines, METH_VARARGS,
"Retrieve HEADER number of lines." },
"Retrieve 'header' number of lines." },
{ "get_value", (PyCFunction) api_header_get_value, METH_VARARGS,
"Retrieve header field value." },
......@@ -216,10 +216,10 @@ static PyMethodDef methods[] = {
"Retrieve the number of header fields." },
{ "get_field_name", (PyCFunction) api_header_get_field_name, METH_VARARGS,
"Retrieve header field name by field index IDX." },
"Retrieve header field name by field index 'idx'." },
{ "get_field_value", (PyCFunction) api_header_get_field_value, METH_VARARGS,
"Retrieve header field value by field index IDX." },
"Retrieve header field value by field index 'idx'." },
{ NULL, NULL, 0, NULL }
};
......
......@@ -393,8 +393,8 @@ api_mailbox_get_url (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "create", (PyCFunction) api_mailbox_create, METH_VARARGS,
"Allocate and initialize MBOX. The concrete mailbox type "
"instantiate is based on the scheme of the url NAME." },
"Allocate and initialize 'mbox'. The concrete mailbox type "
"instantiate is based on the scheme of the url 'name'." },
{ "create_default", (PyCFunction) api_mailbox_create_default, METH_VARARGS,
"Create a mailbox with mu_mailbox_create() based on the "
......@@ -402,35 +402,35 @@ static PyMethodDef methods[] = {
"__PATH_MAILDIR_/USER or LOGNAME if USER is null." },
{ "destroy", (PyCFunction) api_mailbox_destroy, METH_VARARGS,
"Destroy and release resources held by MBOX." },
"Destroy and release resources held by 'mbox'." },
{ "open", (PyCFunction) api_mailbox_open, METH_VARARGS,
"A connection is open, if no stream was provided, a stream is "
"created based on the MBOX type. The FLAG can be OR'ed." },
"created based on the 'mbox' type. The 'flag' can be OR'ed." },
{ "close", (PyCFunction) api_mailbox_close, METH_VARARGS,
"The stream attached to MBOX is closed." },
"The stream attached to 'mbox' is closed." },
{ "flush", (PyCFunction) api_mailbox_flush, METH_VARARGS,
"" },
{ "messages_count", (PyCFunction) api_mailbox_messages_count, METH_VARARGS,
"Give the number of messages in MBOX." },
"Give the number of messages in 'mbox'." },
{ "messages_recent", (PyCFunction) api_mailbox_messages_recent, METH_VARARGS,
"Give the number of recent messages in MBOX." },
"Give the number of recent messages in 'mbox'." },
{ "message_unseen", (PyCFunction) api_mailbox_message_unseen, METH_VARARGS,
"Give the number of first unseen message in MBOX." },
{ "get_message", (PyCFunction) api_mailbox_get_message, METH_VARARGS,
"Retrieve message number MSGNO, MESSAGE is allocated and initialized." },
"Retrieve message number 'msgno', 'message' is allocated and initialized." },
{ "append_message", (PyCFunction) api_mailbox_append_message, METH_VARARGS,
"Append MESSAGE to the mailbox MBOX." },
"Append 'message' to the mailbox 'mbox'." },
{ "expunge", (PyCFunction) api_mailbox_expunge, METH_VARARGS,
"Expunge deleted messages from the mailbox MBOX." },
"Expunge deleted messages from the mailbox 'mbox'." },
{ "sync", (PyCFunction) api_mailbox_sync, METH_VARARGS,
"" },
......
......@@ -262,7 +262,7 @@ api_mailcap_entry_get_viewcommand (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "create", (PyCFunction) api_mailcap_create, METH_VARARGS,
"Allocate, parse the buffer from the STREAM and initializes MAILCAP." },
"Allocate, parse the buffer from the 'stream' and initializes 'mailcap'." },
{ "destroy", (PyCFunction) api_mailcap_destroy, METH_VARARGS,
"Release any resources from the mailcap object." },
......@@ -271,7 +271,7 @@ static PyMethodDef methods[] = {
"Return the number of entries found in the mailcap." },
{ "get_entry", (PyCFunction) api_mailcap_get_entry, METH_VARARGS,
"Return in ENTRY the mailcap entry of NO." },
"Return in 'entry' the mailcap entry of 'no'." },
{ "entry_fields_count", (PyCFunction) api_mailcap_entry_fields_count,
METH_VARARGS,
......
......@@ -192,7 +192,7 @@ static PyMethodDef methods[] = {
"Create mailer." },
{ "destroy", (PyCFunction) api_mailer_destroy, METH_VARARGS,
"The resources allocate for MSG are freed." },
"The resources allocate for 'msg' are freed." },
{ "open", (PyCFunction) api_mailer_open, METH_VARARGS,
"" },
......
......@@ -354,28 +354,28 @@ static PyMethodDef methods[] = {
"Create message." },
{ "destroy", (PyCFunction) api_message_destroy, METH_VARARGS,
"The resources allocate for MSG are freed." },
"The resources allocate for 'msg' are freed." },
{ "is_multipart", (PyCFunction) api_message_is_multipart, METH_VARARGS,
"" },
{ "size", (PyCFunction) api_message_size, METH_VARARGS,
"Retrieve MSG size." },
"Retrieve 'msg' size." },
{ "lines", (PyCFunction) api_message_lines, METH_VARARGS,
"Retrieve MSG number of lines." },
"Retrieve 'msg' number of lines." },
{ "get_envelope", (PyCFunction) api_message_get_envelope, METH_VARARGS,
"Retrieve MSG envelope." },
"Retrieve 'msg' envelope." },
{ "get_header", (PyCFunction) api_message_get_header, METH_VARARGS,
"Retrieve MSG header." },
"Retrieve 'msg' header." },
{ "get_body", (PyCFunction) api_message_get_body, METH_VARARGS,
"Retrieve MSG body." },
"Retrieve 'msg' body." },
{ "get_attribute", (PyCFunction) api_message_get_attribute, METH_VARARGS,
"Retrieve MSG attribute." },
"Retrieve 'msg' attribute." },
{ "get_num_parts", (PyCFunction) api_message_get_num_parts, METH_VARARGS,
"" },
......
......@@ -435,24 +435,24 @@ api_sieve_set_logger (PyObject *self, PyObject *args)
static PyMethodDef methods[] = {
{ "machine_init", (PyCFunction) api_sieve_machine_init, METH_VARARGS,
"Create and initialize new Sieve MACHine." },
"Create and initialize new Sieve 'machine'." },
{ "machine_destroy", (PyCFunction) api_sieve_machine_destroy, METH_VARARGS,
"Destroy Sieve MACHine." },
"Destroy Sieve 'machine'." },
{ "compile", (PyCFunction) api_sieve_compile, METH_VARARGS,
"Compile the sieve script from the file NAME." },
"Compile the sieve script from the file 'name'." },
{ "disass", (PyCFunction) api_sieve_disass, METH_VARARGS,
"Dump the disassembled code of the sieve machine MACH." },
"Dump the disassembled code of the sieve machine 'mach'." },
{ "mailbox", (PyCFunction) api_sieve_mailbox, METH_VARARGS,
"Execute the code from the given instance of sieve machine "
"MACH over each message in the mailbox MBOX." },
"'mach' over each message in the mailbox 'mbox'." },
{ "message", (PyCFunction) api_sieve_message, METH_VARARGS,
"Execute the code from the given instance of sieve machine "
"MACH over the MESSAGE. " },
"'mach' over the 'message'. " },
{ "set_debug", (PyCFunction) api_sieve_set_debug, METH_VARARGS,
"" },
......