Skip to content

Commit

Permalink
[TASK] Regenerate ViewHelper documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NamelessCoder committed Sep 6, 2023
1 parent f49c435 commit 9bd8349
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions Documentation/ViewHelpers/Format/Replace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ format.replace

Replaces $substring in $content with $replacement.

Supports array as input substring/replacements and content.

When input substring/replacement is an array, both must be
the same length and must contain only strings.

When input content is an array, the search/replace is done
on every value in the input content array and the return
value will be an array of equal size as the input content
array but with all values search/replaced. All values in the
input content array must be strings.

Arguments
=========

Expand All @@ -24,7 +35,7 @@ content
:aspect:`Required`
false
:aspect:`Description`
Content in which to perform replacement
Content in which to perform replacement. Array supported.

.. _format.replace_substring:

Expand All @@ -37,7 +48,7 @@ substring
:aspect:`Required`
true
:aspect:`Description`
Substring to replace
Substring to replace. Array supported.

.. _format.replace_replacement:

Expand All @@ -50,7 +61,7 @@ replacement
:aspect:`Required`
false
:aspect:`Description`
Replacement to insert
Replacement to insert. Array supported.

.. _format.replace_returncount:

Expand Down

0 comments on commit 9bd8349

Please sign in to comment.