From 46615e447b330bab8087efa3271eb275d47f77ce Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 2 Nov 2025 15:30:21 +1100 Subject: [PATCH] Docs fix (#10738) * Fix heading in helpers.md * Helper func docs --- docs/docs/report/helpers.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/docs/report/helpers.md b/docs/docs/report/helpers.md index 59c63f58c0..817aff67d9 100644 --- a/docs/docs/report/helpers.md +++ b/docs/docs/report/helpers.md @@ -273,7 +273,7 @@ To convert a currency value from one currency to another, use the `convert_curre !!! info "Data Types" The `money` parameter must be `Money` class instance. If not, an error will be raised. -#### create_currency +### create_currency Create a `currency` instance using the `create_currency` helper function. This returns a `Money` class instance based on the provided amount and currency type. @@ -286,12 +286,13 @@ Create a `currency` instance using the `create_currency` helper function. This r Simple mathematical operators are available, as demonstrated in the example template below. These operators can be used to perform basic arithmetic operations within the report template. -### Input Types - -These mathematical functions accept inputs of various input types, and attempt to perform the operation accordingly. Note that any inputs which are provided as strings or numbers will be converted to `Decimal` class types before the operation is performed. +!!! info "Input Types" + These mathematical functions accept inputs of various input types, and attempt to perform the operation accordingly. Note that any inputs which are provided as strings or numbers will be converted to `Decimal` class types before the operation is performed. ### add +Add two numbers together using the `add` helper function: + ::: report.templatetags.report.add options: show_docstring_description: false @@ -299,6 +300,8 @@ These mathematical functions accept inputs of various input types, and attempt t ### subtract +Subtract one number from another using the `subtract` helper function: + ::: report.templatetags.report.subtract options: show_docstring_description: false @@ -306,6 +309,8 @@ These mathematical functions accept inputs of various input types, and attempt t ### multiply +Multiply two numbers together using the `multiply` helper function: + ::: report.templatetags.report.multiply options: show_docstring_description: false @@ -313,6 +318,8 @@ These mathematical functions accept inputs of various input types, and attempt t ### divide +Divide one number by another using the `divide` helper function: + ::: report.templatetags.report.divide options: show_docstring_description: false @@ -320,6 +327,8 @@ These mathematical functions accept inputs of various input types, and attempt t ### modulo +Perform a modulo operation using the `modulo` helper function: + ::: report.templatetags.report.modulo options: show_docstring_description: false