From e836cfb0f6b5e09e4d050d3c2e795d1577c5ea62 Mon Sep 17 00:00:00 2001 From: Sebastien Helleu Date: Mon, 4 Feb 2013 10:29:51 +0100 Subject: [PATCH] Move comments with description of python file to top of files --- src/qweechat/about.py | 6 ++---- src/qweechat/buffer.py | 6 ++---- src/qweechat/chat.py | 6 ++---- src/qweechat/config.py | 6 ++---- src/qweechat/connection.py | 6 ++---- src/qweechat/debug.py | 6 ++---- src/qweechat/input.py | 6 ++---- src/qweechat/network.py | 6 ++---- src/qweechat/qweechat.py | 5 +++-- src/qweechat/weechat/color.py | 6 ++---- src/qweechat/weechat/protocol.py | 8 ++++---- 11 files changed, 25 insertions(+), 42 deletions(-) diff --git a/src/qweechat/about.py b/src/qweechat/about.py index 74c0beb..80023b4 100644 --- a/src/qweechat/about.py +++ b/src/qweechat/about.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# about.py - about dialog box +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# About dialog box. -# - import qt_compat QtCore = qt_compat.import_module('QtCore') QtGui = qt_compat.import_module('QtGui') diff --git a/src/qweechat/buffer.py b/src/qweechat/buffer.py index 0c09e91..704abce 100644 --- a/src/qweechat/buffer.py +++ b/src/qweechat/buffer.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# buffer.py - management of WeeChat buffers/nicklist +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Buffers. -# - import qt_compat QtCore = qt_compat.import_module('QtCore') QtGui = qt_compat.import_module('QtGui') diff --git a/src/qweechat/chat.py b/src/qweechat/chat.py index 3e91bc4..4ed7d97 100644 --- a/src/qweechat/chat.py +++ b/src/qweechat/chat.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# chat.py - chat area +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Chat area. -# - import datetime import qt_compat QtCore = qt_compat.import_module('QtCore') diff --git a/src/qweechat/config.py b/src/qweechat/config.py index 8e4d456..efcaff7 100644 --- a/src/qweechat/config.py +++ b/src/qweechat/config.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# config.py - configuration for QWeeChat (~/.qweechat/qweechat.conf) +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Configuration for QWeeChat (~/.qweechat/qweechat.conf) -# - import os, ConfigParser import weechat.color as color diff --git a/src/qweechat/connection.py b/src/qweechat/connection.py index 0ceff69..0f19cb5 100644 --- a/src/qweechat/connection.py +++ b/src/qweechat/connection.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# connection.py - connection window +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Connection window. -# - import qt_compat QtGui = qt_compat.import_module('QtGui') diff --git a/src/qweechat/debug.py b/src/qweechat/debug.py index 0b844e8..e14cdab 100644 --- a/src/qweechat/debug.py +++ b/src/qweechat/debug.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# debug.py - debug window +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Debug window. -# - import qt_compat QtGui = qt_compat.import_module('QtGui') from chat import ChatTextEdit diff --git a/src/qweechat/input.py b/src/qweechat/input.py index ee3b2e6..42c3f8e 100644 --- a/src/qweechat/input.py +++ b/src/qweechat/input.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# input.py - input line for chat and debug window +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Input line (for chat or debug window). -# - import qt_compat QtCore = qt_compat.import_module('QtCore') QtGui = qt_compat.import_module('QtGui') diff --git a/src/qweechat/network.py b/src/qweechat/network.py index af3ab1c..9b49222 100644 --- a/src/qweechat/network.py +++ b/src/qweechat/network.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# network.py - I/O with WeeChat/relay +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# I/O with WeeChat/relay. -# - import struct import qt_compat QtCore = qt_compat.import_module('QtCore') diff --git a/src/qweechat/qweechat.py b/src/qweechat/qweechat.py index 55bd70b..61d7fcf 100755 --- a/src/qweechat/qweechat.py +++ b/src/qweechat/qweechat.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# qweechat.py - WeeChat remote GUI using Qt toolkit +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -20,8 +22,7 @@ # # -# QWeeChat - WeeChat remote GUI using Qt toolkit. -# (this script requires WeeChat 0.3.7 or newer, running on local or remote host) +# This script requires WeeChat 0.3.7 or newer, running on local or remote host. # # History: # diff --git a/src/qweechat/weechat/color.py b/src/qweechat/weechat/color.py index 63472e9..09195a0 100644 --- a/src/qweechat/weechat/color.py +++ b/src/qweechat/weechat/color.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# color.py - remove/replace colors in WeeChat strings +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -19,10 +21,6 @@ # along with QWeeChat. If not, see . # -# -# Remove or replace colors in WeeChat strings. -# - import re RE_COLOR_ATTRS = r'[*!/_|]*' diff --git a/src/qweechat/weechat/protocol.py b/src/qweechat/weechat/protocol.py index 056eac4..b0a4fb1 100644 --- a/src/qweechat/weechat/protocol.py +++ b/src/qweechat/weechat/protocol.py @@ -1,6 +1,8 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # +# protocol.py - decode binary messages received from WeeChat/relay +# # Copyright (C) 2011-2013 Sebastien Helleu # # This file is part of QWeeChat, a Qt remote GUI for WeeChat. @@ -20,10 +22,8 @@ # # -# Decode binary messages received from WeeChat/relay. -# -# For info about protocol and format of messages, please read document "WeeChat Relay Protocol", -# available at: http://www.weechat.org/doc/ +# For info about protocol and format of messages, please read document +# "WeeChat Relay Protocol", available at: http://www.weechat.org/doc/ # # History: #