Uploaded image for project: 'Ruby Driver'
  1. Ruby Driver
  2. RUBY-2177

Fix warnings in API docs

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 2.12.0
    • Affects Version/s: None
    • Component/s: None

      [warn]: @param tag has unknown parameter name: options
          in file `lib/mongo/uri.rb' near line 226
      [warn]: @param tag has unknown parameter name: The
          in file `lib/mongo/session.rb' near line 703
      [warn]: @param tag has unknown parameter name: block
          in file `lib/mongo/retryable.rb' near line 154
      [warn]: @param tag has unknown parameter name: The
          in file `lib/mongo/crypt/hooks.rb' near line 72
      [warn]: @param tag has unknown parameter name: The
          in file `lib/mongo/crypt/hooks.rb' near line 72
      [warn]: Unknown tag @sections in file `lib/mongo/protocol/msg.rb` near line 169
      [warn]: @param tag has unknown parameter name: len
          in file `lib/mongo/crypt/binding.rb' near line 65
      [warn]: @param tag has unknown parameter name: data
          in file `lib/mongo/crypt/binding.rb' near line 83
      [warn]: @param tag has unknown parameter name: len
          in file `lib/mongo/crypt/binding.rb' near line 83
      [warn]: @param tag has unknown parameter name: binary
          in file `lib/mongo/crypt/binding.rb' near line 94
      [warn]: @param tag has unknown parameter name: binary
          in file `lib/mongo/crypt/binding.rb' near line 101
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 108
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 133
      [warn]: @param tag has unknown parameter name: type
          in file `lib/mongo/crypt/binding.rb' near line 133
      [warn]: @param tag has unknown parameter name: code
          in file `lib/mongo/crypt/binding.rb' near line 133
      [warn]: @param tag has unknown parameter name: message
          in file `lib/mongo/crypt/binding.rb' near line 133
      [warn]: @param tag has unknown parameter name: len
          in file `lib/mongo/crypt/binding.rb' near line 133
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 144
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 151
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 160
      [warn]: @param tag has unknown parameter name: len
          in file `lib/mongo/crypt/binding.rb' near line 160
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 167
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 174
      [warn]: @param tag has unknown parameter name: level
          in file `lib/mongo/crypt/binding.rb' near line 197
      [warn]: @param tag has unknown parameter name: message
          in file `lib/mongo/crypt/binding.rb' near line 197
      [warn]: @param tag has unknown parameter name: len
          in file `lib/mongo/crypt/binding.rb' near line 197
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 197
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 213
      [warn]: @param tag has unknown parameter name: log_fn
          in file `lib/mongo/crypt/binding.rb' near line 213
      [warn]: @param tag has unknown parameter name: log_ctx
          in file `lib/mongo/crypt/binding.rb' near line 213
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 242
      [warn]: @param tag has unknown parameter name: aws_access_key_id
          in file `lib/mongo/crypt/binding.rb' near line 242
      [warn]: @param tag has unknown parameter name: aws_access_key_id_len
          in file `lib/mongo/crypt/binding.rb' near line 242
      [warn]: @param tag has unknown parameter name: aws_secret_access_key
          in file `lib/mongo/crypt/binding.rb' near line 242
      [warn]: @param tag has unknown parameter name: aws_secret_access_key_len
          in file `lib/mongo/crypt/binding.rb' near line 242
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 276
      [warn]: @param tag has unknown parameter name: key
          in file `lib/mongo/crypt/binding.rb' near line 276
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 303
      [warn]: @param tag has unknown parameter name: schema_map
          in file `lib/mongo/crypt/binding.rb' near line 303
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 327
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 347
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 347
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 354
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 362
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 371
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 371
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 381
      [warn]: @param tag has unknown parameter name: key_id
          in file `lib/mongo/crypt/binding.rb' near line 381
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 409
      [warn]: @param tag has unknown parameter name: binary
          in file `lib/mongo/crypt/binding.rb' near line 409
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 444
      [warn]: @param tag has unknown parameter name: algorithm
          in file `lib/mongo/crypt/binding.rb' near line 444
      [warn]: @param tag has unknown parameter name: len
          in file `lib/mongo/crypt/binding.rb' near line 444
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 475
      [warn]: @param tag has unknown parameter name: region
          in file `lib/mongo/crypt/binding.rb' near line 475
      [warn]: @param tag has unknown parameter name: region_len
          in file `lib/mongo/crypt/binding.rb' near line 475
      [warn]: @param tag has unknown parameter name: arn
          in file `lib/mongo/crypt/binding.rb' near line 475
      [warn]: @param tag has unknown parameter name: arn_len
          in file `lib/mongo/crypt/binding.rb' near line 475
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 508
      [warn]: @param tag has unknown parameter name: endpoint
          in file `lib/mongo/crypt/binding.rb' near line 508
      [warn]: @param tag has unknown parameter name: endpoint_len
          in file `lib/mongo/crypt/binding.rb' near line 508
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 536
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 563
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 589
      [warn]: @param tag has unknown parameter name: db
          in file `lib/mongo/crypt/binding.rb' near line 589
      [warn]: @param tag has unknown parameter name: db_len
          in file `lib/mongo/crypt/binding.rb' near line 589
      [warn]: @param tag has unknown parameter name: cmd
          in file `lib/mongo/crypt/binding.rb' near line 589
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 625
      [warn]: @param tag has unknown parameter name: msg
          in file `lib/mongo/crypt/binding.rb' near line 625
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 637
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 654
      [warn]: @param tag has unknown parameter name: doc
          in file `lib/mongo/crypt/binding.rb' near line 654
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 662
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 679
      [warn]: @param tag has unknown parameter name: msg
          in file `lib/mongo/crypt/binding.rb' near line 679
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 691
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 718
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 729
      [warn]: @param tag has unknown parameter name: op_bson
          in file `lib/mongo/crypt/binding.rb' near line 729
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 760
      [warn]: @param tag has unknown parameter name: reply
          in file `lib/mongo/crypt/binding.rb' near line 760
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 783
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 790
      [warn]: @param tag has unknown parameter name: kms
          in file `lib/mongo/crypt/binding.rb' near line 816
      [warn]: @param tag has unknown parameter name: msg
          in file `lib/mongo/crypt/binding.rb' near line 816
      [warn]: @param tag has unknown parameter name: kms
          in file `lib/mongo/crypt/binding.rb' near line 844
      [warn]: @param tag has unknown parameter name: endpoint
          in file `lib/mongo/crypt/binding.rb' near line 844
      [warn]: @param tag has unknown parameter name: kms
          in file `lib/mongo/crypt/binding.rb' near line 870
      [warn]: @param tag has unknown parameter name: kms
          in file `lib/mongo/crypt/binding.rb' near line 888
      [warn]: @param tag has unknown parameter name: bytes
          in file `lib/mongo/crypt/binding.rb' near line 888
      [warn]: Unknown tag @oaram in file `lib/mongo/crypt/binding.rb` near line 896
      [warn]: @param tag has unknown parameter name: kms
          in file `lib/mongo/crypt/binding.rb' near line 911
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 911
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 934
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 955
      [warn]: @param tag has unknown parameter name: op_bson
          in file `lib/mongo/crypt/binding.rb' near line 955
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 981
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 1000
      [warn]: @param tag has unknown parameter name: key
          in file `lib/mongo/crypt/binding.rb' near line 1000
      [warn]: @param tag has unknown parameter name: iv
          in file `lib/mongo/crypt/binding.rb' near line 1000
      [warn]: @param tag has unknown parameter name: in
          in file `lib/mongo/crypt/binding.rb' near line 1000
      [warn]: @param tag has unknown parameter name: out
          in file `lib/mongo/crypt/binding.rb' near line 1000
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 1000
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 1021
      [warn]: @param tag has unknown parameter name: key
          in file `lib/mongo/crypt/binding.rb' near line 1021
      [warn]: @param tag has unknown parameter name: in
          in file `lib/mongo/crypt/binding.rb' near line 1021
      [warn]: @param tag has unknown parameter name: out
          in file `lib/mongo/crypt/binding.rb' near line 1021
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 1021
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 1040
      [warn]: @param tag has unknown parameter name: in
          in file `lib/mongo/crypt/binding.rb' near line 1040
      [warn]: @param tag has unknown parameter name: out
          in file `lib/mongo/crypt/binding.rb' near line 1040
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 1040
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 1054
      [warn]: @param tag has unknown parameter name: out
          in file `lib/mongo/crypt/binding.rb' near line 1054
      [warn]: @param tag has unknown parameter name: count
          in file `lib/mongo/crypt/binding.rb' near line 1054
      [warn]: @param tag has unknown parameter name: status
          in file `lib/mongo/crypt/binding.rb' near line 1054
      [warn]: @param tag has unknown parameter name: crypt
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: An
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: An
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/binding.rb' near line 1069
      [warn]: @param tag has unknown parameter name: ctx
          in file `lib/mongo/crypt/context.rb' near line 34
      [warn]: @param tag has unknown parameter name: A
          in file `lib/mongo/crypt/context.rb' near line 34
      [warn]: @param tag has unknown parameter name: The
          in file `lib/mongo/grid/file/info.rb' near line 214
      [warn]: Unknown tag @params in file `lib/mongo/client_encryption.rb` near line 63
      [warn]: @param tag has unknown parameter name: client:
          in file `lib/mongo/crypt/encryption_io.rb' near line 52
      [warn]: @param tag has unknown parameter name: mongocryptd_client:
          in file `lib/mongo/crypt/encryption_io.rb' near line 52
      [warn]: @param tag has unknown parameter name: key_vault_client:
          in file `lib/mongo/crypt/encryption_io.rb' near line 52
      [warn]: @param tag has unknown parameter name: key_vault_namespace:
          in file `lib/mongo/crypt/encryption_io.rb' near line 52
      [warn]: @param tag has unknown parameter name: mongocryptd_options:
          in file `lib/mongo/crypt/encryption_io.rb' near line 52
      [warn]: @param tag has unknown parameter name: block
          in file `lib/mongo/crypt/encryption_io.rb' near line 244
      [warn]: Unknown tag @params in file `lib/mongo/crypt/explicit_encrypter.rb` near line 32
      [warn]: Unknown tag @params in file `lib/mongo/crypt/explicit_encrypter.rb` near line 32
      [warn]: Unknown tag @params in file `lib/mongo/crypt/explicit_encrypter.rb` near line 63
      [warn]: @param tag has unknown parameter name: db_name
          in file `lib/mongo/crypt/auto_decryption_context.rb' near line 33
      [warn]: @param tag has unknown parameter name: The
          in file `lib/mongo/server/connection_pool/populator.rb' near line 28
      [warn]: Unknown tag @raises in file `lib/mongo/crypt/explicit_encryption_context.rb` near line 42
      [warn]: @param tag has unknown parameter name: Session
          in file `lib/mongo/operation/shared/response_handling.rb' near line 72
      [warn]: @param tag has unknown parameter name: symbol
          in file `lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb' near line 64
      [warn]: In file `lib/mongo/error/parser.rb':76: Cannot resolve link to code: from text:
      	...{code: 123, codeName: 'foo'}...
      [warn]: In file `lib/mongo/uri/srv_protocol.rb':20: Cannot resolve link to hostname from text:
      	...{hostname}...
      [warn]: In file `lib/mongo/uri/srv_protocol.rb':20: Cannot resolve link to domainname from text:
      	...{domainname}...
      

            Assignee:
            emily.giurleo@mongodb.com Emily Giurleo (Inactive)
            Reporter:
            emily.giurleo@mongodb.com Emily Giurleo (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: