http://www.mediawiki.org/wiki/Special:Code/pywikipedia/9892
Revision: 9892 Author: xqt Date: 2012-02-13 14:07:56 +0000 (Mon, 13 Feb 2012) Log Message: ----------- docstring from wikipedia.family() from rewrite
Modified Paths: -------------- trunk/pywikipedia/wikipedia.py
Modified: trunk/pywikipedia/wikipedia.py =================================================================== --- trunk/pywikipedia/wikipedia.py 2012-02-13 10:20:05 UTC (rev 9891) +++ trunk/pywikipedia/wikipedia.py 2012-02-13 14:07:56 UTC (rev 9892) @@ -4713,12 +4713,16 @@ # two statements. Always ensure that a local reference is created when # accessing Family objects _familyCache = weakref.WeakValueDictionary() -def Family(fam = None, fatal = True, force = False): - """ - Import the named family. +def Family(fam=None, fatal=True, force=False): + """Import the named family.
- If fatal is True, the bot will stop running when the given family is - unknown. If fatal is False, it will only raise a ValueError exception. + @param fam: family name (if omitted, uses the configured default) + @type fam: str + @param fatal: if True, the bot will stop running if the given family is + unknown. If False, it will only raise a ValueError exception. + @param fatal: bool + @return: a Family instance configured for the named family. + """ if fam is None: fam = config.family