update URI option documentation

Author: saghm

docs/tutorials/ruby-driver-create-client.txt

@@ -92,111 +92,146 @@ URI Options Conversions
 
 .. list-table::
    :header-rows: 1
-   :widths: 40 105
+   :widths: 40 150 200
 
    * - URI Option
      - Ruby Option
+     - Notes
 
    * - appName=String
      - ``:app_name => String``
+     -
 
    * - authMechanism=String
      - ``:auth_mech => Symbol``
+     -
 
    * - authMechanismProperties=Strings
-     - ``{ :auth_mech_properties => { :service_realm => String, :canonicalize_host_name => true|false, :service_name => String } }``
+     - ``{ :auth_mech_properties =>``
+         ``{ :service_realm => String,``
+           ``:canonicalize_host_name => true|false,``
+           ``:service_name => String } }``
+     - Specified as comma-separated key:value pairs, e.g.
+       ``"SERVICE_REALM:foo,CANONICALIZE_HOSTNAME:TRUE"``
 
    * - authSource=String
      - ``:auth_source => String``
+     -
 
    * - compressors=Strings
      - ``:compressors => Array<String>``
+     - Specified as a comma-separated list, e.g. "zlib,snappy"
 
    * - connect=String
      - ``:connect => Symbol``
+     -
 
    * - ssl=Boolean
      - ``:ssl => true|false``
+     -
 
    * - connectTimeoutMS=Integer
      - ``:connect_timeout => Float``
+     -
 
    * - fsync=Boolean
      - ``{ :write => { :fsync => true|false }}``
+     -
 
    * - heartbeatFrequencyMS=Integer
      - ``:heartbeat_frequency => Float``
+     -
 
    * - journal=Boolean
      - ``{ :write => { :j => true|false }}``
+     -
 
    * - localThresholdMS=Integer
      - ``:local_threshold => Float``
+     -
 
    * - maxIdleTimeMS=Integer
      - ``:max_idle_time => Float``
+     -
 
    * - maxPoolSize=Integer
      - ``:max_pool_size => Integer``
+     -
 
    * - minPoolSize=Integer
      - ``:min_pool_size => Integer``
+     -
 
    * - readPreference=String
      - ``{ :read => { :mode => Symbol }}``
+     -
 
    * - readPreferenceTags=Strings
-     - ``{ :read => { :tag_sets => Array<String> }}``
+     - ``{ :read => { :tag_sets => Array<Hash> }}``
+     - Each instance of the readPreferenceTags field is a comma-separated key:value pair which will
+       appear in the :tag_sets array in the order they are specified. For instance,
+       ``"readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny"`` will be converted to
+       ``[ { 'dc' => 'ny', 'rack' => '1' }, { 'dc' => 'ny' }]``.
 
    * - replicaSet=String
      - ``:replica_set => String``
+     -
 
    * - serverSelectionTimeoutMS=Integer
      - ``:server_selection_timeout => Float``
+     -
 
    * - socketTimeoutMS=Integer
      - ``:socket_timeout => Float``
+     -
 
    * - tls=Boolean
      - ``:ssl => boolean``
+     -
 
    * - tlsAllowInvalidCertificates=Boolean
      - ``:ssl_verify => boolean``
-
-       NOTE: Because ``tlsAllowInvalidCertificates`` uses ``true`` to sigify that verification
+     - Because ``tlsAllowInvalidCertificates`` uses ``true`` to signify that verification
        should be disabled and ``ssl_verify`` uses ``false`` to signify that verification should be
        disabled, the boolean is inverted before being used to set ``ssl_verify``
 
    * - tlsCAFile=String
      - ``:ssl_ca_cert => String``
+     -
 
    * - tlsClientCertFile=String
      - ``:ssl_cert => String``
+     -
 
    * - tlsClientKeyFile=String
      - ``:ssl_key => String``
+     -
 
    * - tlsClientKeyPassword=String
      - ``:ssl_key_pass_phrase => String``
+     -
 
    * - tlsInsecure=Boolean
      - ``:ssl_verify => boolean``
-
-       NOTE: Because tlsInsecure uses ``true`` to sigify that verification should be disabled and
+     - Because tlsInsecure uses ``true`` to signify that verification should be disabled and
        ``ssl_verify`` uses ``false`` to signify that verification should be disabled, the boolean
        is inverted before being used to set ``ssl_verify``
 
    * - w=Integer|String
      - ``{ :write => { :w => Integer|String }}``
+     -
 
    * - waitQueueTimeoutMS=Integer
      - ``:wait_queue_timeout => Float``
+     -
 
    * - wtimeoutMS=Integer
      - ``{ :write => { :wtimeout => Float }}``
+     -
 
    * - zlibCompressionLevel=Integer
      - ``:zlib_compression_level => Integer``
+     -
 
 
 Ruby Options