From ecdd7b3e374c8e76d417df9897edc00750e1141b Mon Sep 17 00:00:00 2001 From: Hussain Nagaria Date: Wed, 20 Dec 2023 14:02:32 +0530 Subject: [PATCH] docs: consistency --- frappe/core/doctype/server_script/server_script.py | 2 +- frappe/core/doctype/user/user.py | 4 ++-- frappe/database/operator_map.py | 14 +++++++------- frappe/utils/data.py | 2 +- frappe/utils/identicon.py | 2 +- frappe/utils/scheduler.py | 4 ++-- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/frappe/core/doctype/server_script/server_script.py b/frappe/core/doctype/server_script/server_script.py index eaa8bc4b96..a9e047d9b2 100644 --- a/frappe/core/doctype/server_script/server_script.py +++ b/frappe/core/doctype/server_script/server_script.py @@ -135,7 +135,7 @@ class ServerScript(Document): frappe.PermissionError: If self.allow_guest is unset for API accessed by Guest user. Return: - dict: Evaluate self.script with frappe.utils.safe_exec.safe_exec and return the flags set in it's safe globals. + dict: Evaluate self.script with frappe.utils.safe_exec.safe_exec and return the flags set in its safe globals. """ if self.enable_rate_limit: diff --git a/frappe/core/doctype/user/user.py b/frappe/core/doctype/user/user.py index a56bfaaca0..1a13a20e4e 100644 --- a/frappe/core/doctype/user/user.py +++ b/frappe/core/doctype/user/user.py @@ -1083,7 +1083,7 @@ def user_query(doctype, txt, searchfield, start, page_len, filters): def get_total_users(): - """Return total no. of system users.""" + """Return total number of system users.""" return flt( frappe.db.sql( """SELECT SUM(`simultaneous_sessions`) @@ -1131,7 +1131,7 @@ def get_active_users(): def get_website_users(): - """Return total no. of website users.""" + """Return total number of website users.""" return frappe.db.count("User", filters={"enabled": True, "user_type": "Website User"}) diff --git a/frappe/database/operator_map.py b/frappe/database/operator_map.py index 8f77db5687..72ed8b4a75 100644 --- a/frappe/database/operator_map.py +++ b/frappe/database/operator_map.py @@ -18,7 +18,7 @@ def like(key: Field, value: str) -> frappe.qb: value (str): criterion Return: - frappe.qb: `frappe.qb object with `LIKE` + frappe.qb: `frappe.qb` object with `LIKE` """ return key.like(value) @@ -31,7 +31,7 @@ def func_in(key: Field, value: list | tuple) -> frappe.qb: value (Union[int, str]): criterion Return: - frappe.qb: `frappe.qb object with `IN` + frappe.qb: `frappe.qb` object with `IN` """ if isinstance(value, str): value = value.split(",") @@ -46,7 +46,7 @@ def not_like(key: Field, value: str) -> frappe.qb: value (str): criterion Return: - frappe.qb: `frappe.qb object with `NOT LIKE` + frappe.qb: `frappe.qb` object with `NOT LIKE` """ return key.not_like(value) @@ -59,7 +59,7 @@ def func_not_in(key: Field, value: list | tuple | str): value (Union[int, str]): criterion Return: - frappe.qb: `frappe.qb object with `NOT IN` + frappe.qb: `frappe.qb` object with `NOT IN` """ if isinstance(value, str): value = value.split(",") @@ -74,7 +74,7 @@ def func_regex(key: Field, value: str) -> frappe.qb: value (str): criterion Return: - frappe.qb: `frappe.qb object with `REGEX` + frappe.qb: `frappe.qb` object with `REGEX` """ return key.regex(value) @@ -87,7 +87,7 @@ def func_between(key: Field, value: list | tuple) -> frappe.qb: value (Union[int, str]): criterion Return: - frappe.qb: `frappe.qb object with `BETWEEN` + frappe.qb: `frappe.qb` object with `BETWEEN` """ return key[slice(*value)] @@ -105,7 +105,7 @@ def func_timespan(key: Field, value: str) -> frappe.qb: value (str): criterion Return: - frappe.qb: `frappe.qb object with `TIMESPAN` + frappe.qb: `frappe.qb` object with `TIMESPAN` """ return func_between(key, get_timespan_date_range(value)) diff --git a/frappe/utils/data.py b/frappe/utils/data.py index 016c62ba79..8a40235ea2 100644 --- a/frappe/utils/data.py +++ b/frappe/utils/data.py @@ -126,7 +126,7 @@ def getdate( def get_datetime( - datetime_str: Optional["DateTimeLikeObject"] = None, + datetime_str: "DateTimeLikeObject" | list | tuple | datetime.timedelta | None = None, ) -> datetime.datetime | None: """Return the below mentioned values based on the given `datetime_str`: diff --git a/frappe/utils/identicon.py b/frappe/utils/identicon.py index 43517087d0..724af20464 100644 --- a/frappe/utils/identicon.py +++ b/frappe/utils/identicon.py @@ -28,7 +28,7 @@ class Identicon: self.hash = self.digest(str_) def digest(self, str_): - """Return a md5 numeric hash.""" + """Return an MD5 numeric hash.""" return int(md5(str_.encode("utf-8"), usedforsecurity=False).hexdigest(), 16) def calculate(self): diff --git a/frappe/utils/scheduler.py b/frappe/utils/scheduler.py index 8c048c1a16..88cb85b667 100755 --- a/frappe/utils/scheduler.py +++ b/frappe/utils/scheduler.py @@ -141,8 +141,8 @@ def disable_scheduler(): def schedule_jobs_based_on_activity(check_time=None): - """Return True for active sites defined by Activity Log. - Also return True for inactive sites once in 24 hours.""" + """Return True for active sites as defined by `Activity Log`. + Also return True for inactive sites once every 24 hours based on `Scheduled Job Log`.""" if is_dormant(check_time=check_time): # ensure last job is one day old last_job_timestamp = _get_last_modified_timestamp("Scheduled Job Log")