Revision: 6476
Author: nicdumz
Date: 2009-03-03 10:01:59 +0000 (Tue, 03 Mar 2009)
Log Message:
-----------
Documentation.
Modified Paths:
--------------
branches/rewrite/pywikibot/data/logentries.py
branches/rewrite/pywikibot/page.py
Modified: branches/rewrite/pywikibot/data/logentries.py
===================================================================
--- branches/rewrite/pywikibot/data/logentries.py 2009-03-03 09:56:02 UTC (rev 6475)
+++ branches/rewrite/pywikibot/data/logentries.py 2009-03-03 10:01:59 UTC (rev 6476)
@@ -14,7 +14,7 @@
from pywikibot import date
class LogDict(dict):
- """Simple custom dictionary that raises an APIError instead of a
KeyError"""
+ """Simple custom dictionary that raises a custom Error instead of a
KeyError"""
def __missing__(self, key):
pywikibot.output(u"API log entry received:\n" + repr(self),
level=pywikibot.DEBUG)
@@ -23,6 +23,9 @@
class LogEntry(object):
"""Generic log entry"""
+ # Log type expected. None for every type, or one of the (letype) str :
+ # block/patrol/etc...
+ # Overriden in subclasses.
_expectedType = None
def __init__(self, apidata):
Modified: branches/rewrite/pywikibot/page.py
===================================================================
--- branches/rewrite/pywikibot/page.py 2009-03-03 09:56:02 UTC (rev 6475)
+++ branches/rewrite/pywikibot/page.py 2009-03-03 10:01:59 UTC (rev 6476)
@@ -962,7 +962,7 @@
pywikibot.output(u'Moving %s to [[%s]].'
% (self.title(asLink=True), newtitle))
reason = pywikibot.input(u'Please enter a reason for the move:')
- # TODO: implement "safe" parameter
+ # TODO: implement "safe" parameter (Is this necessary ?)
# TODO: implement "sysop" parameter
return self.site().movepage(self, newtitle, reason,
movetalk=movetalkpage,
@@ -1112,7 +1112,13 @@
oldCat and newCat should be Category objects.
If newCat is None, the category will be removed.
- """ # TODO: document remaining arguments
+ comment: string to use as an edit summary
+
+ sortKey: sortKey to use for the added category.
+ Unused if newCat is None, or if inPlace=True
+
+ """
+ #TODO: is inPlace necessary?
site = self.site()
changesMade = False