jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/862225 )
Change subject: [doc] Fix docstring in maintenance/cache.py
......................................................................
[doc] Fix docstring in maintenance/cache.py
Change-Id: I2220879df7906b6c27eea792efe676337f970117
---
M scripts/maintenance/cache.py
1 file changed, 20 insertions(+), 15 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/scripts/maintenance/cache.py b/scripts/maintenance/cache.py
index 2340fab..9ae4129 100755
--- a/scripts/maintenance/cache.py
+++ b/scripts/maintenance/cache.py
@@ -74,6 +74,7 @@
import pickle
import sys
from pathlib import Path
+from typing import Optional
import pywikibot
from pywikibot.data import api
@@ -217,23 +218,18 @@
self._cachefile_path().unlink()
-def process_entries(cache_path, func, use_accesstime=None, output_func=None,
- action_func=None):
- """
- Check the contents of the cache.
+def process_entries(cache_path, func, use_accesstime: Optional[bool] = None,
+ output_func=None, action_func=None):
+ """Check the contents of the cache.
- This program tries to use file access times to determine
- whether cache files are being used.
- However file access times are not always usable.
- On many modern filesystems, they have been disabled.
- On Unix, check the filesystem mount options. You may
- need to remount with 'strictatime'.
+ This program tries to use file access times to determine whether
+ cache files are being used. However file access times are not always
+ usable. On many modern filesystems, they have been disabled. On Unix,
+ check the filesystem mount options. You may need to remount with
+ 'strictatime'.
- :param use_accesstime: Whether access times should be used.
- :type use_accesstime: bool tristate:
- - None = detect
- - False = don't use
- - True = always use
+ :param use_accesstime: Whether access times should be used. `None`
+ for detect, `False` for don't use and `True` for always use.
"""
if not cache_path:
cache_path = os.path.join(pywikibot.config.base_dir,
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/862225
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I2220879df7906b6c27eea792efe676337f970117
Gerrit-Change-Number: 862225
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: D3r1ck01 <xsavitar.wiki(a)aol.com>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged