浏览代码

Add clarification note on code copy/pasting

Alois Mahdal 9 年前
父节点
当前提交
7a27fbdab2
共有 1 个文件被更改,包括 5 次插入0 次删除
  1. 5
    0
      guidelines/markdown.md

+ 5
- 0
guidelines/markdown.md 查看文件

117
  *  Unless you are pasting *output*, avoid prompt char (`$`, `%`, `%`)
117
  *  Unless you are pasting *output*, avoid prompt char (`$`, `%`, `%`)
118
     in order to provide code that can be copied.  To convey the need of
118
     in order to provide code that can be copied.  To convey the need of
119
     root privilege, mention that in surrounding text or use *sudo*.
119
     root privilege, mention that in surrounding text or use *sudo*.
120
+
121
+    Note that this does not mean that code *should* be copied around
122
+    to a productive environment, but in most cases it's good if reader
123
+    can *try it out* the snippet.  Know your audience and use your best
124
+    judgment.