clarify documentation of docker.link()

2014-11-28 12:59:20 -07:00 · 2014-11-28 12:59:20 -07:00 · 5ae5690d66
parent 1c884fa4e5
commit 5ae5690d66
1 changed files with 2 additions and 1 deletions
--- a/website/docs/source/v2/docker/configuration.html.md
+++ b/website/docs/source/v2/docker/configuration.html.md
@ -36,7 +36,8 @@ General settings:
    but not to the host machine. Useful for links.

  * `link` (method, string argument) - Link this container to another
-    by name. Example: `docker.link("db:db")`. Note, if you're linking to
+    by name. The argument should be in the format of `(name:alias)`.
+    Example: `docker.link("db:db")`. Note, if you're linking to
    another container in the same Vagrantfile, make sure you call
    `vagrant up` with the `--no-parallel` flag.