diff --git a/frappe/utils/error.py b/frappe/utils/error.py index 0aaaa02e2b..15bb9e8a47 100644 --- a/frappe/utils/error.py +++ b/frappe/utils/error.py @@ -100,8 +100,6 @@ def get_default_args(func): def raise_error_on_no_output(error_message, error_type=None, keep_quiet=None): """Decorate any function to throw error incase of missing output. - TODO: Remove keep_quiet flag after testing and fixing sendmail flow. - :param error_message: error message to raise :param error_type: type of error to raise :param keep_quiet: control error raising with external factor. @@ -109,11 +107,22 @@ def raise_error_on_no_output(error_message, error_type=None, keep_quiet=None): :type error_type: Exception Class :type keep_quiet: function - >>> @raise_error_on_no_output("Ingradients missing") - ... def get_indradients(_raise_error=1): - ... return - >>> get_ingradients() - `Exception Name`: Ingradients missing + --- + Example: + + ```py + @raise_error_on_no_output("Ingredients are missing") + def get_ingredients(_raise_error=1): + return + + + # this will raise an Exception with message "Ingredients are missing" + ingredients = get_ingredients() + ``` + + --- + + TODO: Remove keep_quiet flag after testing and fixing sendmail flow. """ def decorator_raise_error_on_no_output(func):