From 56661c4c665bc1820d2e1629b9968e20b395256a Mon Sep 17 00:00:00 2001
From: Kyle Banker <kylebanker@gmail.com>
Date: Tue, 4 May 2010 16:06:06 -0400
Subject: [PATCH] minor: docs

---
 lib/mongo/connection.rb    | 3 +++
 test/connection_test.rb    | 1 -
 test/cursor_test.rb        | 1 -
 test/db_api_test.rb        | 1 -
 test/db_connection_test.rb | 1 -
 test/db_test.rb            | 1 -
 test/test_helper.rb        | 1 -
 7 files changed, 3 insertions(+), 6 deletions(-)

diff --git a/lib/mongo/connection.rb b/lib/mongo/connection.rb
index 4f88a5f..aa8fdc2 100644
--- a/lib/mongo/connection.rb
+++ b/lib/mongo/connection.rb
@@ -172,6 +172,9 @@ module Mongo
     # specificed in the list of auths. This method is called automatically
     # by DB#authenticate.
     #
+    # Note: this method will not actually issue an authentication command. To do that,
+    # either run Connection#apply_saved_authentication or DB#authenticate.
+    #
     # @param [String] db_name
     # @param [String] username
     # @param [String] password
diff --git a/test/connection_test.rb b/test/connection_test.rb
index bbbf17a..238faf0 100644
--- a/test/connection_test.rb
+++ b/test/connection_test.rb
@@ -3,7 +3,6 @@ require 'logger'
 require 'stringio'
 require 'thread'
 
-# NOTE: assumes Mongo is running
 class TestConnection < Test::Unit::TestCase
 
   include Mongo
diff --git a/test/cursor_test.rb b/test/cursor_test.rb
index 97eba3c..eec9ad8 100644
--- a/test/cursor_test.rb
+++ b/test/cursor_test.rb
@@ -1,7 +1,6 @@
 require 'test/test_helper'
 require 'logger'
 
-# NOTE: assumes Mongo is running
 class CursorTest < Test::Unit::TestCase
 
   include Mongo
diff --git a/test/db_api_test.rb b/test/db_api_test.rb
index 3705a2b..5a5113b 100644
--- a/test/db_api_test.rb
+++ b/test/db_api_test.rb
@@ -1,6 +1,5 @@
 require 'test/test_helper'
 
-# NOTE: assumes Mongo is running
 class DBAPITest < Test::Unit::TestCase
   include Mongo
   include BSON
diff --git a/test/db_connection_test.rb b/test/db_connection_test.rb
index 7a1920b..f6ad1e5 100644
--- a/test/db_connection_test.rb
+++ b/test/db_connection_test.rb
@@ -1,6 +1,5 @@
 require 'test/test_helper'
 
-# NOTE: assumes Mongo is running
 class DBConnectionTest < Test::Unit::TestCase
 
   include Mongo
diff --git a/test/db_test.rb b/test/db_test.rb
index 659e70b..51ba360 100644
--- a/test/db_test.rb
+++ b/test/db_test.rb
@@ -10,7 +10,6 @@ class TestPKFactory
   end
 end
 
-# NOTE: assumes Mongo is running
 class DBTest < Test::Unit::TestCase
 
   include Mongo
diff --git a/test/test_helper.rb b/test/test_helper.rb
index 762c018..fccca2d 100644
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -23,7 +23,6 @@ require 'bson_ext/cbson' if ENV['C_EXT']
 
 MONGO_TEST_DB = 'mongo-ruby-test'
 
-# NOTE: most tests assume that MongoDB is running.
 class Test::Unit::TestCase
   include Mongo
   include BSON