typos and stuff

README.md

@@ -132,7 +132,8 @@ Nchan supports several different kinds of subscribers for receiving messages: *W
 
 PubSub endpoints are Nginx config *locations* with the *`nchan_pubsub`* directive.
 
-A combination of *publisher* and *subscriber* endpoints, this location treats all **HTTP `GET`** requests as subscribers, and all **HTTP `POST`** as publishers. One simple use case is an echo server:
+A combination of *publisher* and *subscriber* endpoints, this location treats all HTTP `GET`
+requests as subscribers, and all HTTP `POST` as publishers. One simple use case is an echo server:
 
 ```nginx
   location = /pubsub {
@@ -151,7 +152,7 @@ A more applicable setup may set different publisher and subscriber channel ids:
   }
 ```
 
-Here, subscribers will listen for messages on channel `foo`, and publishers will publish messages to channel `bar'. This can be useful when setting up websocket proxying between web clients and your application.
+Here, subscribers will listen for messages on channel `foo`, and publishers will publish messages to channel `bar`. This can be useful when setting up websocket proxying between web clients and your application.
 
 ## The Channel ID
 

src/nchan_commands.rb

@@ -37,7 +37,7 @@
 
       group: "pubsub",
       default: "(none)",
-      info: "Defines a server or location as a publisher and subscriber endpoint. For long-polling, GETs subscribe. and POSTS publish. For Websockets, publishing data on a connection does not yield a channel metadata response. Without additional configuration, this turns a location into an echo server."
+      info: "Defines a server or location as a publisher and subscriber endpoint. For long-polling, GETs subscribe. and POSTs publish. For Websockets, publishing data on a connection does not yield a channel metadata response. Without additional configuration, this turns a location into an echo server."
 
   nchan_subscriber [:srv, :loc, :if],
       :nchan_subscriber_directive,
@@ -58,7 +58,7 @@
       group: "pubsub",
       value: ["oldest", "newest"],
       default: "newest",
-      info: "Controls the first message received by a new subscriber. 'oldest' returns the oldest available message in a channel's message queue, 'newest' waits until a message arrives"
+      info: "Controls the first message received by a new subscriber. 'oldest' returns the oldest available message in a channel's message queue, 'newest' waits until a message arrives."
 
   nchan_subscriber_concurrency [:main, :srv, :loc, :if],
       :nchan_set_subscriber_concurrency,
@@ -97,7 +97,7 @@
 
       group: "security",
       value: "<url>",
-      info: "send GET request to internal location (which may proxy to an upstream server) for authorization of ap ublisher or subscriber request. A 200 response authorizes the request, a 403 response forbids it."
+      info: "Send GET request to internal location (which may proxy to an upstream server) for authorization of a publisher or subscriber request. A 200 response authorizes the request, a 403 response forbids it."
 
   nchan_store_messages [:main, :srv, :loc, :if],
       :nchan_store_messages_directive,
@@ -174,7 +174,7 @@
       group: "storage",
       value: "<number>",
       default: 10,
-      info: "The maximum number of messages to store per channel. A channel's message buffer will retain at most this many most recent messages."
+      info: "The maximum number of messages to store per channel. A channel's message buffer will retain a maximum of this many most recent messages."
 
   nchan_delete_oldest_received_message [:main, :srv, :loc],
       :ngx_conf_set_flag_slot,
@@ -194,7 +194,7 @@
       group: "security",
       value: [:on, :off],
       default: :off,
-      info: "Whether or not a subscriber may create a channel by making a request to a push_subscriber location. If set to on, a publisher must send a POST or PUT request before a subscriber can request messages on the channel. Otherwise, all subscriber requests to nonexistent channels will get a 403 Forbidden response."
+      info: "Whether or not a subscriber may create a channel by sending a request to a push_subscriber location. If set to on, a publisher must send a POST or PUT request before a subscriber can request messages on the channel. Otherwise, all subscriber requests to nonexistent channels will get a 403 Forbidden response."
 
   nchan_channel_group [:srv, :loc, :if], 
       :ngx_conf_set_str_slot, 
@@ -212,7 +212,7 @@
       args: 1,
 
       group: "meta",
-      info: "Channel id where `nchan_channel_id`'s events should be sent. Things like subscriber enqueue/dequeue, publishing messages, etc. Useful for application debugging. The channel event message is configurable via nchan_channel_event_string. The channel group for events is hardcoded to 'meta'."
+      info: "Channel id where `nchan_channel_id`'s events should be sent. Events like subscriber enqueue/dequeue, publishing messages, etc. Useful for application debugging. The channel event message is configurable via nchan_channel_event_string. The channel group for events is hardcoded to 'meta'."
 
   nchan_channel_event_string [:srv, :loc, :if], 
       :ngx_http_set_complex_value_slot,
@@ -246,13 +246,16 @@
   nchan_channel_timeout [:main, :srv, :loc],
       :ngx_conf_set_sec_slot,
       [:loc_conf, :channel_timeout],
-      legacy: "push_channel_timeout"
+      legacy: "push_channel_timeout",
+
+      group: "development",
+      info: "Amount of time an empty channel hangs around. Don't mess with this setting unless you know what you are doing!"
 
   nchan_storage_engine [:main, :srv, :loc],
       :nchan_set_storage_engine, 
       [:loc_conf, :storage_engine],
       legacy: "push_storage_engine",
 
       group: "development",
-      info: "development directive to completely replace default storage engine. Don't use unless you know what you're doing"
+      info: "Development directive to completely replace default storage engine. Don't use unless you know what you're doing"
 end