From e9bbe03354079cfcef65a77b0c33f57b047a7c93 Mon Sep 17 00:00:00 2001
From: Abdeali Chharchhoda <abdealiking786@gmail.com>
Date: Sun, 10 Nov 2024 12:37:46 +0530
Subject: [PATCH] chore: Improve caching decorators docstring

---
 frappe/utils/caching.py | 47 ++++++++++++++++++++++++++++-------------
 1 file changed, 32 insertions(+), 15 deletions(-)

diff --git a/frappe/utils/caching.py b/frappe/utils/caching.py
index 2fc9dfaf4d..cb788549fc 100644
--- a/frappe/utils/caching.py
+++ b/frappe/utils/caching.py
@@ -22,23 +22,31 @@ def __generate_request_cache_key(args: tuple, kwargs: dict):
 
 
 def request_cache(func: Callable) -> Callable:
-	"""Decorator to cache function calls mid-request. Cache is stored in
-	frappe.local.request_cache. The cache only persists for the current request
-	and is cleared when the request is over. The function is called just once
-	per request with the same set of (kw)arguments.
+	"""
+	Decorator to cache function calls mid-request.
 
+	Cache is stored in `frappe.local.request_cache`.
+
+	The cache only persists for the current request and is cleared when the request is over.
+
+	The function is called just once per request with the same set of (kw)arguments.
+
+	---
 	Usage:
+	```
 	        from frappe.utils.caching import request_cache
 
 	        @request_cache
 	        def calculate_pi(num_terms=0):
-	                import math, time
-	                print(f"{num_terms = }")
-	                time.sleep(10)
-	                return math.pi
+	            import math, time
 
-	        calculate_pi(10) # will calculate value
-	        calculate_pi(10) # will return value from cache
+	            print(f"{num_terms = }")
+	            time.sleep(10)
+	            return math.pi
+
+	        calculate_pi(10)  # will calculate value
+	        calculate_pi(10)  # will return value from cache
+	```
 	"""
 
 	@wraps(func)
@@ -64,27 +72,36 @@ def request_cache(func: Callable) -> Callable:
 
 
 def site_cache(ttl: int | None = None, maxsize: int | None = None) -> Callable:
-	"""Decorator to cache method calls across requests. The cache is stored in
-	frappe.utils.caching._SITE_CACHE. The cache persists on the parent process.
+	"""
+	Decorator to cache method calls across requests.
+
+	The cache is stored in `frappe.utils.caching._SITE_CACHE`.
+
+	The cache persists on the parent process.
+
 	It offers a light-weight cache for the current process without the additional
 	overhead of serializing / deserializing Python objects.
 
 	Note: This cache isn't shared among workers. If you need to share data across
 	workers, use redis (frappe.cache API) instead.
 
+	---
 	Usage:
+	```
 	        from frappe.utils.caching import site_cache
 
 	        @site_cache
 	        def calculate_pi():
-	                import math, time
-	                precision = get_precision("Math Constant", "Pi") # depends on site data
-	                return round(math.pi, precision)
+	            import math, time
+
+	            precision = get_precision("Math Constant", "Pi") # depends on site data
+	            return round(math.pi, precision)
 
 	        calculate_pi(10) # will calculate value
 	        calculate_pi(10) # will return value from cache
 	        calculate_pi.clear_cache() # clear this function's cache for all sites
 	        calculate_pi(10) # will calculate value
+	```
 	"""
 
 	def time_cache_wrapper(func: Callable | None = None) -> Callable: