-cdef void report_disconnect_reason (connection.PurpleConnection *gc,
- connection.PurpleConnectionError reason,
- const_char *text):
- debug.c_purple_debug_info("connection", "%s", "report-disconnect-reason\n")
+cdef void report_disconnect_reason(connection.PurpleConnection *gc, \
+ connection.PurpleConnectionError reason, const_char *c_text):
+ """
+ Called when an error causes a connection to be disconnected. Called
+ before disconnected. This op is intended to replace report_disconnect.
+ If both are implemented, this will be called first; however, there's no
+ real reason to implement both.
+ @param reason why the connection ended, if known, or
+ PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not.
+ @param text a localized message describing the disconnection
+ in more detail to the user.
+ @see purple_connection_error_reason
+ @since 2.3.0
+ """
+ debug.purple_debug_info("connection", "%s", "report-disconnect-reason\n")