From 903d2a2bdc761a6cb83fc822c912d39e6562a1b2 Mon Sep 17 00:00:00 2001 From: Avinash Sonawane Date: Thu, 6 Jan 2022 11:49:49 +0530 Subject: [PATCH] Improvement to docs (#698) * Docs : Clarify `addslashes` filter * Docs : Clarify `slugify` filter * Docs : Clarify `trim_start_matches` & `trim_end_matches` filters --- docs/content/docs/_index.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/content/docs/_index.md b/docs/content/docs/_index.md index 720b4188..6ef22ec0 100644 --- a/docs/content/docs/_index.md +++ b/docs/content/docs/_index.md @@ -789,21 +789,20 @@ the `from` string replaced with the `to` string. Example: `{{ name | replace(from="Robert", to="Bob")}}` #### addslashes -Adds slashes before quotes. +Adds slashes before single quote (`'`), double quote (`"`) and slash (`\`) chars. Example: `{{ value | addslashes }}` -If value is "I'm using Tera", the output will be "I\\'m using Tera". +If value is \`Alice said, "I'm using \\ in Tera"\`, the output will be \`Alice said, \\"I\\'m using \\\\ in Tera\\"\`. #### slugify Only available if the `builtins` feature is enabled. -Transforms a string into ASCII, lowercases it, trims it, converts spaces to hyphens and -removes all characters that are not numbers, lowercase letters or hyphens. +Transforms a string into ASCII, lowercases it, trims it, converts all characters that are not numbers or lowercase letters to hyphens, replaces continuous sequence of hyphens with a single hyphen and removes leading and trailing hyphens if any. Example: `{{ value | slugify }}` -If value is "-Hello world! ", the output will be "hello-world". +If value is " -This-- Is तेरा! ", the output will be "this-is-teraa". #### title Capitalizes each word inside a sentence. @@ -822,16 +821,16 @@ Removes leading whitespace if the variable is a string. Removes trailing whitespace if the variable is a string. #### trim_start_matches -Removes leading characters that match the given pattern if the variable is a string. +Repeatedly removes leading characters that match the given pattern if the variable is a string. -Example: `{{ value | trim_start_matches(pat="//") }}` +Example: `{{ value | trim_start_matches(pat="/") }}` If value is "//a/b/c//", the output will be "a/b/c//". #### trim_end_matches -Removes trailing characters that match the given pattern if the variable is a string. +Repeatedly removes trailing characters that match the given pattern if the variable is a string. -Example: `{{ value | trim_end_matches(pat="//") }}` +Example: `{{ value | trim_end_matches(pat="/") }}` If value is "//a/b/c//", the output will be "//a/b/c".