We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent dd83864 commit 9214d89Copy full SHA for 9214d89
STYLEGUIDE.md
@@ -31,6 +31,19 @@ so it's best to use it from the start.
31
32
### Language
33
34
+##### 'say' vs 'put'
35
+
36
+While there is no hard and fast rule about which of these routines to use
37
+in a given situation, please try to follow these guidelines.
38
39
+When generating output in examples intended to be read by a user, use 'say'.
40
+Additionally, add a comment showing the intended output, e.g.:
41
42
+ say 3.^name; #OUTPUT: «Int»
43
44
+For examples where a particular format is required, or exact data is expected
45
+(e.g. for something sent over a network connection), prefer 'put'.
46
47
##### 'parameter' vs 'argument'
48
49
* Argument: what it looks like to the caller
0 commit comments