document regex_replace Jinja filter

[mbunkus]

Description of Issue/Question

The "Understanding Jinja" section documents and lists regex_match and regex_search but not regex_replace. However, that function is actually present in salt/utils/jinja.py and works just fine.

It should really be documented. I've been Googling for ways to regex-replace in Jinja several times now, seeing as the documentation stated such a function doesn't exist, and only a look under the hood (into jinja.py) revealed that it does exist after all.

Steps to Reproduce Issue

Small test state that shows the function works just fine:

{% set a = '/tmp/hellely' %}
{{ a | regex_replace('l(.)', 'a\\1') }}:
  file.directory

Saving this as testme.sls & executing it (salt-call testme) will create /tmp/healeay as expected.

Versions Report

Salt Version:
           Salt: 2018.3.2

Dependency Versions:
           cffi: Not Installed
       cherrypy: Not Installed
       dateutil: Not Installed
      docker-py: Not Installed
          gitdb: Not Installed
      gitpython: Not Installed
          ioflo: Not Installed
         Jinja2: 2.10
        libgit2: Not Installed
        libnacl: Not Installed
       M2Crypto: 0.30.1
           Mako: 1.0.7
   msgpack-pure: Not Installed
 msgpack-python: 0.5.6
   mysql-python: Not Installed
      pycparser: Not Installed
       pycrypto: 2.6.1
   pycryptodome: Not Installed
         pygit2: Not Installed
         Python: 2.7.15 (default, Jun 27 2018, 13:05:28)
   python-gnupg: Not Installed
         PyYAML: 3.12
          PyZMQ: 17.0.0
           RAET: Not Installed
          smmap: Not Installed
        timelib: Not Installed
        Tornado: 4.5.3
            ZMQ: 4.2.3

System Versions:
           dist:
         locale: UTF-8
        machine: x86_64
        release: 4.17.5-1-ARCH
         system: Linux
        version: Not Installed

[garethgreenaway]

@mbunkus Thanks for the report. It looks like the documentation for this function is available in salt/utils/jinja.py so the docstring for the regex_search function would simply need to be copied into salt/doc/topics/jinja/index.rst. We would definitely welcome a pull request with this addition.

[mbunkus]

Oh, I wasn't aware that they're not built automatically from the Python files somehow. Sure, I can whip up a PR.

[rallytime]

Thanks @mbunkus!

[mbunkus]

You're quite welcome.