Browse code

#2209 - add the example @tianon gave to elaborate on the Comment documentation

Sven Dowideit authored on 2013/10/15 21:19:07
Showing 1 changed files
... ...
@@ -54,8 +54,14 @@ Docker evaluates the instructions in a Dockerfile in order. **The
54 54
 first instruction must be `FROM`** in order to specify the
55 55
 :ref:`base_image_def` from which you are building.
56 56
 
57
-Docker will ignore **comment lines** *beginning* with ``#``. A comment
58
-marker anywhere in the rest of the line will be treated as an argument.
57
+Docker will treat lines that *begin* with ``#`` as a comment. A ``#``
58
+marker anywhere else in the line will be treated as an argument. This
59
+allows statements like:
60
+
61
+::
62
+
63
+    # Comment
64
+    RUN echo 'we are running some # of cool things'
59 65
 
60 66
 3. Instructions
61 67
 ===============