rm/cc feedback

Author: mongoKart

source/upgrade.txt

@@ -61,41 +61,24 @@ the version after v4.0 including any listed under v4.5.
 Version 5.0 Breaking Changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- This driver version introduces the following changes to the ``ConnectionId`` class:
-  
-  - The ``ConnectionId`` constructor now accepts a value of type ``long`` as its second
-    parameter instead of type ``int``. Similarly, the constructor now accepts a value of
-    type ``Long`` as its third parameter instead of type ``Integer``. Because this change breaks
-    binary compatibility, recompile any existing code that calls the ``ConnectionId`` constructor.
-
-  - The ``withServerValue()`` method now accepts a parameter of type ``long`` rather than
-    type ``int``. This change breaks binary compatibility, so you must recompile any code
-    that calls the ``withServerValue()`` method.
+This driver version introduces the following breaking changes:
 
-  - The ``getServerValue()`` method now returns a value of type ``Long`` instead of type
-    ``Integer``. Similarly, the ``getLocalValue()`` method returns a value of type
-    ``long`` instead of type ``int``. Because this change breaks both binary and source
-    compatibility, update any source code that uses these methods and rebuild your binary.
+- Changes the data type of the timeout duration parameter in the
+  ``SocketSettings.Builder.connectTimeout()`` and ``SocketSettings.Builder.readTimeout()``
+  methods. The data type of this parameter is now ``long`` instead of ``int``.
+  To view an
+  example that shows how to instantiate a ``SocketSettings`` instance by using
+  these methods, see the :ref:`SocketSettings Example
+  <java-socketsettings-example>` in the Specify MongoClient Settings
+  guide.
 
-- This driver version removes the following record annotations:
+- Removes the following record annotations:
 
   - ``BsonId``
   - ``BsonProperty``
   - ``BsonRepresentation``
 
-- You must pass a timeout duration, which is the first parameter, to the
-  following ``SocketSettings`` builder methods as a ``long`` type:
-
-  - ``connectTimeout()``
-  - ``readTimeout()``
-
-  In earlier versions, this parameter is of type ``int`` for both methods. To view an example
-  that shows how to instantiate a ``SocketSettings`` instance by using
-  these methods, see the :ref:`SocketSettings Example
-  <java-socketsettings-example>` in the Specify MongoClient Settings
-  guide.
-
-- This driver version removes the ``Filters.eqFull()`` method, which allowed you
+- Removes the ``Filters.eqFull()`` method, which allowed you
   to construct an equality filter when performing a vector search.
   You can use the ``Filters.eq()`` method when instantiating a
   ``VectorSearchOptions`` type, as shown in the following code:
@@ -105,41 +88,34 @@ Version 5.0 Breaking Changes
      VectorSearchOptions opts = vectorSearchOptions().filter(eq("x", 8));
 
 .. _java-breaking-changes-v5.0-observables:
-
-- This driver version removes the
-  ``org.mongodb.scala.ObservableImplicits.ToSingleObservableVoid`` implicit
-  class. This means the ``org.reactivestreams.Publisher[Void]`` type no longer
-  converts automatically to ``org.mongodb.scala.SingleObservable[Void]``. The
-  API also exposes ``org.mongodb.scala.Observable[Unit]`` instead of
-  ``org.mongodb.scala.Observable[Void]``. 
 
   .. After the 5.0 Scala API docs are released, this line will be uncommented. 
     For more information, see the `Observable trait documentation <https://mongodb.github.io/mongo-java-driver/5.0/apidocs/mongo-scala-driver/org/mongodb/scala/Observable.html>`__.
 
-- This driver version removes the ``Parameterizable`` interface. Instead of
+- Removes the ``Parameterizable`` interface. Instead of
   implementing this interface on a custom ``Codec`` type,
   override the ``CodecProvider.get()`` method on the
   codec's ``CodecProvider`` if the codec is intended for a parameterized
   type.
 
-- This driver version removes the ``isSlaveOk()`` method from the
+- Removes the ``isSlaveOk()`` method from the
   ``ReadPreference`` and ``TaggableReadPreference`` classes. To check whether a read preference allows
   reading from a secondary member of a replica set, use the ``isSecondaryOk()`` methods from
   these classes instead.
 
-- This driver version removes the ``DBCollection.getStats()`` and ``DBCollection.isCapped()``
+- Removes the ``DBCollection.getStats()`` and ``DBCollection.isCapped()``
   helper methods for the ``collStats`` command. Instead of these methods, you can use the
   ``$collStats`` aggregation pipeline stage. For an example of how to use this pipeline
   stage, see :manual:`What's New <java-deprecations-4.11>` for v4.11 of the {+driver-short+}.
 
-- This driver version removes the ``IterableCodec`` and ``MapCodec`` types.
-  Use ``MapCodecProvider`` instead of ``MapCodec`` and ``CollectionCodecProvider``
+- Removes the ``IterableCodec`` and ``MapCodec`` types.
+  Use ``MapCodecProvider`` instead of ``MapCodec``, and ``CollectionCodecProvider``
   instead of ``IterableCodec``.
 
-- This driver version removes the ``sharded`` and ``nonAtomic`` options from the
+- Removes the ``sharded`` and ``nonAtomic`` options from the
   ``MapReducePublisher`` and ``MapReduceIterable`` classes.
 
-- This driver version removes the following methods for use with ``geoHaystack`` indexes:
+- Removes the following methods for use with ``geoHaystack`` indexes:
 
   - ``Indexes.geoHaystack()``
   - ``IndexOptions.getBucketSize()``
@@ -149,7 +125,7 @@ Version 5.0 Breaking Changes
   query operator on a 2d index. For more information, see the
   :manual:`Geospatial Queries page </geospatial-queries>` in the {+mdb-server+} manual.
 
-- This driver version removes the ``oplogReplay`` option from find operations. This
+- Removes the ``oplogReplay`` option from find operations. This
   includes the following methods:
 
   - ``DBCursor.oplogReplay()``
@@ -158,28 +134,27 @@ Version 5.0 Breaking Changes
   - ``FindPublisher.oplogReplay()``
   - ``FindIterable.oplogReplay()``
 
-- This driver version removes the following ``Exception`` constructors:
+- Removes the following ``Exception`` constructors:
 
   - ``MongoBulkWriteException(BulkWriteResult, List<BulkWriteError>, WriteConcernError, ServerAddress)``
   - ``MongoCursorNotFoundException(long, ServerAddress)``
   - ``MongoQueryException(ServerAddress, int, String)``
   - ``MongoQueryException(ServerAddress, int, String, String)``
   - ``MongoQueryException(MongoCommandException)``
 
-- This driver version removes the following overloads for the
-  ``BulkWriteResult.acknowledged()`` method:
+- Removes the following overloads for the ``BulkWriteResult.acknowledged()`` method:
 
   - ``acknowledged(Type, int, List<BulkWriteUpsert>)``
   - ``acknowledged(Type, int, Integer, List<BulkWriteUpsert>)``
   - ``acknowledged(int, int, int, Integer, List<BulkWriteUpsert>)<String>)``
 
-- This driver version removes the following ``ChangeStreamDocument`` constructors:
+- Removes the following ``ChangeStreamDocument`` constructors:
 
   - ``ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, TDocument, BsonDocument, ...)``
   - ``ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)``
   - ``ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)``
 
-- This driver version removes the following constructors for events:
+- Removes the following constructors for events:
 
   - ``CommandEvent(RequestContext, int, ConnectionDescription, String)``
   - ``CommandEvent(int, ConnectionDescription, String)``
@@ -200,11 +175,35 @@ Version 5.0 Breaking Changes
   - ``ServerHeartbeatFailedEvent(ConnectionId, long, Throwable)``
   - ``ServerHeartbeatSucceededEvent(ConnectionId, BsonDocument, long)``
 
-- This driver version removes the ``errorLabels`` option from the ``WriteConcernError``
+- Removes the ``errorLabels`` option from the ``WriteConcernError``
   class. This includes the ``addLabel()`` and ``getErrorLabels()`` methods and the
   constructor that includes an ``errorLabels`` parameter. Instead, you can use
   the error labels included in the top-level response document.
 
+- Removes the
+  ``org.mongodb.scala.ObservableImplicits.ToSingleObservableVoid`` implicit
+  class from the Scala driver package. This means the
+  ``org.reactivestreams.Publisher[Void]`` type no longer
+  converts automatically to ``org.mongodb.scala.SingleObservable[Void]``. The
+  API also exposes ``org.mongodb.scala.Observable[Unit]`` instead of
+  ``org.mongodb.scala.Observable[Void]``. 
+
+- Introduces the following changes to the ``ConnectionId`` class:
+  
+  - The ``ConnectionId`` constructor now accepts a value of type ``long`` as its second
+    parameter instead of type ``int``. Similarly, the constructor now accepts a value of
+    type ``Long`` as its third parameter instead of type ``Integer``. Because this change breaks
+    binary compatibility, recompile any existing code that calls the ``ConnectionId`` constructor.
+
+  - The ``withServerValue()`` method now accepts a parameter of type ``long`` rather than
+    type ``int``. This change breaks binary compatibility, so you must recompile any code
+    that calls the ``withServerValue()`` method.
+
+  - The ``getServerValue()`` method now returns a value of type ``Long`` instead of type
+    ``Integer``. Similarly, the ``getLocalValue()`` method returns a value of type
+    ``long`` instead of type ``int``. Because this change breaks both binary and source
+    compatibility, update any source code that uses these methods and rebuild your binary.
+
 .. _java-breaking-changes-v4.8:
 
 Version 4.8 Breaking Changes