Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove errant note about changing the name of existing roles. #2642

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Remove errant note about changing the name of existing roles. #2642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/docsite/rst/contributing/creating_role.rst
View file
Open in desktop
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.