Skip to content

Commit

Permalink
Add "/" to connector prefix in docs
Browse files Browse the repository at this point in the history
Add a "/" the connector prefix in the Inventory & Data docs section, so that users know the full syntax immediately.
  • Loading branch information
Nina McLaughlin authored and Fizzadar committed Sep 2, 2023
1 parent 3fb9152 commit 2e21d06
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/inventory-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Inventory & Data

A ``pyinfra`` inventory provides hosts, groups and data. Host are the targets ``pyinfra`` will execute commands or state changes on (think a SSH daemon on a server, a Docker container or the local machine). Hosts can be attached to groups, and data can then be assigned to both the groups of hosts and individual hosts.

By default ``pyinfra`` assumes hosts are SSH servers and the name of the host is used as the SSH hostname. Prefixing the name of the host with ``@<connector-name>`` is used to activate alternative connectors. See: :doc:`connectors`.
By default ``pyinfra`` assumes hosts are SSH servers and the name of the host is used as the SSH hostname. Prefixing the name of the host with ``@<connector-name>/`` is used to activate alternative connectors. See: :doc:`connectors`.

Inventory Files
---------------
Expand Down

0 comments on commit 2e21d06

Please sign in to comment.