[gentoo-commits] proj/gentoo-packages:master commit in: gpackages/libs/package_info/generic_metadata/

[Slava Bacherikov]

commit:     d53882c162487c202140580c4e6f700bdd208ab9
Author:     Slava Bacherikov <slava <AT> bacher09 <DOT> org>
AuthorDate: Thu Aug  2 22:56:00 2012 +0000
Commit:     Slava Bacherikov <slava <AT> bacherikov <DOT> org <DOT> ua>
CommitDate: Thu Aug  2 22:56:00 2012 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/gentoo-packages.git;a=commit;h=d53882c1

Add docstrings to changelog_highlight.py

---
 .../generic_metadata/changelog_highlight.py        |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)

diff --git a/gpackages/libs/package_info/generic_metadata/changelog_highlight.py b/gpackages/libs/package_info/generic_metadata/changelog_highlight.py
index 5ccbd5c..5b2b503 100644
--- a/gpackages/libs/package_info/generic_metadata/changelog_highlight.py
+++ b/gpackages/libs/package_info/generic_metadata/changelog_highlight.py
@@ -37,6 +37,8 @@ Bug = String
 Link = Keyword
 
 class ChangelogLexer(RegexLexer):
+    "Pygments changelog lexer"
+
     name = 'Changelog'
     aliases = ['changelog']
     filenames = ['Changelog']
@@ -96,6 +98,8 @@ class ChangelogLexer(RegexLexer):
     }
 
 class ChangelogHtmlFormater(HtmlFormatter):
+    "Pygments html changelog formater"
+
     def _format_lines(self, tokensource):
         """
         Copyed from pygments source litle modified.
@@ -167,6 +171,8 @@ class ChangelogHtmlFormater(HtmlFormatter):
         return value
 
 class ChangelogStyle(Style):
+    "Pygments style for gentoo changelog"
+
     default_style = ""
     styles = {
         Comment:                'italic #888',
@@ -182,18 +188,29 @@ class ChangelogStyle(Style):
     }
 
 def changelog_highlight(text):
+    "Shortcut for generating highlighted changelog html output"
     return highlight(text, ChangelogLexer(), 
                      ChangelogHtmlFormater(style = ChangelogStyle))
 
 def changelog_termial_highlight(text):
+    """Shortcut for generating highlighted terminal changelog  output
+    Used for debuging lexer """
     return highlight(text, ChangelogLexer(), 
                      Terminal256Formatter(style = ChangelogStyle))
 
 def changelog_style_css():
+    "Shortcut for generating css style for pygments `ChangelogStyle`"
     f = ChangelogHtmlFormater(style = ChangelogStyle)
     return f.get_style_defs()
 
 def group_tokens(text):
+    """Combine tokens to groups
+    Args:
+        text -- changelog text
+    Yields:
+        (group_type, group), where group_type are: `None`, `'version'` or \
+        `'message'`
+        group are array of tuples (toke, value)"""
     c = ChangelogLexer()
     queue = deque()
     group_type = None 
@@ -247,9 +264,11 @@ def tokens_to_text(lex):
     return mystr
 
 def latest_message(text):
+    "Return latest message text"
     return tokens_to_text(latest_message_group(text))
 
 def latest_group_messages(text):
+    "Returns latest messages like it done on packages.gentoo.org"
     groups = latest_group_messages_group(text)
     return tokens_to_text(tokensgroup_to_toknes(groups))