Skip to content

Commit

Permalink
Remove errant note about changing the name of existing roles.
Browse files Browse the repository at this point in the history
See: #2622 (comment)

+label: docsite_pr
  • Loading branch information
geerlingguy authored Mar 10, 2021
1 parent 71e339d commit a721416
Showing 1 changed file with 0 additions and 6 deletions.
6 changes: 0 additions & 6 deletions docs/docsite/rst/contributing/creating_role.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,6 @@ To override the default name, set the ``role_name`` attribute in the role ``meta
Role names are limited to lowercase word characters (i.e., a-z, 0-9) and '_'. No special characters are allowed, including '.',
'-', and space. During import, any '.' and '-' characters contained in the repository name or role_name will be replaced with '_'.

.. note::

Setting the value of *role_name* on an existing role will change the name of the role by converting it
to lowercase, and translating '-' and '.' to '_'. If the name of an existing role should not be
altered, don't set the value of *role_name*.

.. note::

`role_name` is not used at all if the role is installed using its Git URL. Instead, the name of the repo is used.

0 comments on commit a721416

Please sign in to comment.