Permalink
Browse files

Copy editing

  • Loading branch information...
1 parent cb627a3 commit d63fed73c926701658d2f6469e6d0ed0553ce50d @hintjens hintjens committed Dec 30, 2012
Showing with 55 additions and 0 deletions.
  1. +55 −0 styles.txt
View
@@ -0,0 +1,55 @@
+Style Guide
+
+Hyphenated:
+
+ fan-out
+ fan-in
+ single-part
+ in-process (adj)
+ inter-broker
+ inter-thread
+ load-balancing
+ publish-subscribe
+ pub-sub
+ request-reply
+ step-by-step
+ zero-copy
+ double-check
+ connect-bind pair
+
+No hyphens in:
+
+ frontend
+ backend
+ single socket API
+ timeout
+ online
+ multicast
+ multipart
+ nonfatal
+ general purpose
+ round robin
+ no one
+ side effect
+ use case
+ wish list
+ nontrivial
+ setup (n)
+ set up (v)
+ shut down
+ straightforward
+ failover (n)
+ fail over (v)
+
+Other notes:
+
+ "1 a.m.", "2.30p.m".
+ PUB or SUB in capitals when preceding socket
+ "client/server"
+ Always make sure that i.e. and e.g. are followed by a comma.
+ When referring to version numbers use "0MQ v2.x", "0MQ v3.x"
+ Use "because" not "since" for causation
+ Commas after introductory participles
+ No commas in conjunctions
+ "versus", not "vs."
+ "and so on", not "etc."

0 comments on commit d63fed7

Please sign in to comment.