jenkins-bot has submitted this change and it was merged.
Change subject: PEP257 fixes
......................................................................
PEP257 fixes
Change-Id: I37852eb6d9010051dfaeee99eb064417c26e4832
---
M pywikibot/config2.py
1 file changed, 17 insertions(+), 1 deletion(-)
Approvals:
Ricordisamoa: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/config2.py b/pywikibot/config2.py
index 2f00d57..4527e03 100644
--- a/pywikibot/config2.py
+++ b/pywikibot/config2.py
@@ -1,4 +1,18 @@
# -*- coding: utf-8 -*-
+"""
+Module to define and load pywikibot configuration.
+
+Provides two family class methods which can be used in
+the user-config:
+- register_family_file
+- register_families_folder
+
+Sets module global base_dir and provides utility methods to
+build paths relative to base_dir:
+- makepath
+- datafilepath
+- shortpath
+"""
#
# (C) Rob W.W. Hooft, 2003
# (C) Pywikibot team, 2003-2014
@@ -107,7 +121,7 @@
def _get_base_dir():
- """Return the directory in which user-specific information is stored.
+ r"""Return the directory in which user-specific information is stored.
This is determined in the following order -
1. If the script was called with a -dir: argument, use the directory
@@ -179,6 +193,7 @@
def register_family_file(family_name, file_path):
+ """Register a single family class file."""
usernames[family_name] = {}
sysopnames[family_name] = {}
disambiguation_comment[family_name] = {}
@@ -186,6 +201,7 @@
def register_families_folder(folder_path):
+ """Register all family class files contained in a directory."""
for file_name in os.listdir(folder_path):
if file_name.endswith("_family.py"):
family_name = file_name[:-len("_family.py")]
--
To view, visit https://gerrit.wikimedia.org/r/148018
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I37852eb6d9010051dfaeee99eb064417c26e4832
Gerrit-PatchSet: 2
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: John Vandenberg <jay...@gmail.com>
Gerrit-Reviewer: Ladsgroup <ladsgr...@gmail.com>
Gerrit-Reviewer: Merlijn van Deen <valhall...@arctus.nl>
Gerrit-Reviewer: Ricordisamoa <ricordisa...@openmailbox.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
