Skip to content

Commit 2f7c29f

Browse files
mongoKartmongoKart
committed
rr feedback
1 parent e34fd2c commit 2f7c29f

15 files changed

+105
-104
lines changed

‎snooty.toml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ version = "5.4"
3030
full-version = "{+version+}.0"
3131
mdb-server = "MongoDB Server"
3232
package-name-org = "mongodb-org"
33-
driver-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-sync/com/mongodb/client"
34-
core-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core/com/mongodb"
33+
api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
34+
driver-api = "{+api-root+}/mongodb-driver-sync/com/mongodb/client"
35+
core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
3536
stable-api = "Stable API"
3637
mongocrypt-version = "{+full-version+}"
3738
nettyVersion = "io.netty:netty-all:4.1.87.Final"

‎source/api-documentation.txt‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@ API Documentation
77
.. meta::
88
:description: Read the API documentation for the {+driver-long+} and related packages.
99

10-
- `BSON <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/index.html>`__ - classes for working with the
10+
- `BSON <{+api-root+}/bson/index.html>`__ - classes for working with the
1111
BSON data format.
12-
- `BSON Record Codec <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson-record-codec/index.html>`__ -
12+
- `BSON Record Codec <{+api-root+}/bson-record-codec/index.html>`__ -
1313
classes for encoding and decoding between Java records and the BSON data
1414
format.
15-
- `Core <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core/index.html>`__ - classes that
15+
- `Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
1616
contain essential driver functionality.
17-
- `Java Driver (modern API) <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-sync/index.html>`__ -
17+
- `Java Driver (modern API) <{+api-root+}/mongodb-driver-sync/index.html>`__ -
1818
classes for the current driver API.
19-
- `Java Driver (legacy API) <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-legacy/index.html>`__ -
19+
- `Java Driver (legacy API) <{+api-root+}/mongodb-driver-legacy/index.html>`__ -
2020
classes that support the legacy driver API. To learn how to upgrade from the
2121
legacy API to the modern API from the :ref:`<java-legacy-api>` documentation.
2222

2323
.. toctree::
2424
:titlesonly:
2525
:maxdepth: 1
2626

27-
BSON <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/index.html>
28-
BSON Record Codec <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson-record-codec/index.html>
29-
Core <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core/index.html>
30-
Java Driver (modern API) <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-sync/index.html>
31-
Java Driver (legacy API) <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-legacy/index.html>
27+
BSON <{+api-root+}/bson/index.html>
28+
BSON Record Codec <{+api-root+}/bson-record-codec/index.html>
29+
Core <{+api-root+}/mongodb-driver-core/index.html>
30+
Java Driver (modern API) <{+api-root+}/mongodb-driver-sync/index.html>
31+
Java Driver (legacy API) <{+api-root+}/mongodb-driver-legacy/index.html>
3232

‎source/atlas-vector-search.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,4 @@ guide, see the following API documentation:
104104
- `Projections.metaVectorSearchScore()
105105
<{+core-api+}/client/model/Projections.html#metaVectorSearchScore(java.lang.String)>`__
106106

107-
- `BinaryVector <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BinaryVector.html>`__
107+
- `BinaryVector <{+api-root+}/bson/org/bson/BinaryVector.html>`__

‎source/builders/indexes.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ the field. See our guide on :ref:`Indexes <java-fundamentals-indexes>` for
3131
examples of queries covered by indexes.
3232

3333
The ``Indexes`` class provides static factory methods for all the MongoDB index types.
34-
Each method returns a `BSON <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/conversions/Bson.html>`__
34+
Each method returns a `BSON <{+api-root+}/bson/org/bson/conversions/Bson.html>`__
3535
instance, which you can pass to
3636
`createIndex() <{+driver-api+}/MongoCollection.html#createIndex(org.bson.conversions.Bson,com.mongodb.client.model.IndexOptions)>`__.
3737

‎source/builders/sort.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ For more information about the classes and interfaces in this section, see the
6969
following API Documentation:
7070

7171
- `Sorts <{+core-api+}/client/model/Sorts.html>`__
72-
- `BSON <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/conversions/Bson.html>`__
72+
- `BSON <{+api-root+}/bson/org/bson/conversions/Bson.html>`__
7373
- `FindIterable <{+driver-api+}/FindIterable.html>`__
7474
- `Aggregates <{+core-api+}/client/model/Aggregates.html>`__
7575

‎source/crud/query-documents/sort.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ within an aggregation pipeline. To sort your query results, use the
5656
aggregation pipeline, use the ``Aggregates.sort()`` static factory method. Both
5757
of these methods receive objects that implement the ``Bson`` interface as
5858
arguments. For more information, see our API Documentation for the
59-
`BSON interface <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/conversions/Bson.html>`__.
59+
`BSON interface <{+api-root+}/bson/org/bson/conversions/Bson.html>`__.
6060

6161
You can use the ``sort()`` method of a ``FindIterable`` instance as follows:
6262

@@ -105,8 +105,8 @@ following API Documentation:
105105
- `FindIterable <{+driver-api+}/FindIterable.html>`__
106106
- `Aggregates <{+core-api+}/client/model/Aggregates.html>`__
107107
- `Sorts <{+core-api+}/client/model/Sorts.html>`__
108-
- `BSON <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/conversions/Bson.html>`__
109-
- `Document <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/Document.html>`__
108+
- `BSON <{+api-root+}/bson/org/bson/conversions/Bson.html>`__
109+
- `Document <{+api-root+}/bson/org/bson/Document.html>`__
110110

111111
Sorting Direction
112112
-----------------

‎source/data-formats/codecs.txt‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,13 @@ section of this page to see how you can include your ``Codec``.
136136
For more information about the classes and interfaces in this section, see the
137137
following API Documentation:
138138

139-
- `Codec <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/Codec.html>`__
140-
- `BsonWriter <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BsonWriter.html>`__
141-
- `BsonBinaryWriter <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BsonBinaryWriter.html>`__
142-
- `EncoderContext <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/EncoderContext.html>`__
143-
- `BsonReader <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BsonReader.html>`__
144-
- `DecoderContext <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/DecoderContext.html>`__
145-
- `BsonBinaryReader <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BsonBinaryReader.html>`__
139+
- `Codec <{+api-root+}/bson/org/bson/codecs/Codec.html>`__
140+
- `BsonWriter <{+api-root+}/bson/org/bson/BsonWriter.html>`__
141+
- `BsonBinaryWriter <{+api-root+}/bson/org/bson/BsonBinaryWriter.html>`__
142+
- `EncoderContext <{+api-root+}/bson/org/bson/codecs/EncoderContext.html>`__
143+
- `BsonReader <{+api-root+}/bson/org/bson/BsonReader.html>`__
144+
- `DecoderContext <{+api-root+}/bson/org/bson/codecs/DecoderContext.html>`__
145+
- `BsonBinaryReader <{+api-root+}/bson/org/bson/BsonBinaryReader.html>`__
146146

147147
.. _codecs-codecregistry:
148148

@@ -190,8 +190,8 @@ exception.
190190
For more information about the classes and interfaces in this section, see the
191191
following API Documentation:
192192

193-
- `CodecRegistries <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html>`__
194-
- `IntegerCodec <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/IntegerCodec.html>`__
193+
- `CodecRegistries <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html>`__
194+
- `IntegerCodec <{+api-root+}/bson/org/bson/codecs/IntegerCodec.html>`__
195195

196196
.. _codecs-codecprovider:
197197

@@ -260,7 +260,7 @@ list prior to the default codec registry as shown in the example below:
260260
For more information about the classes and interfaces in this section, see
261261
the following API documentation sections:
262262

263-
- `CodecProvider <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/configuration/CodecProvider.html>`__
263+
- `CodecProvider <{+api-root+}/bson/org/bson/codecs/configuration/CodecProvider.html>`__
264264
- `Default codec registry <{+core-api+}/MongoClientSettings.html#getDefaultCodecRegistry()>`__
265265

266266

@@ -317,7 +317,7 @@ This code outputs the following:
317317
Java type: java.util.Set
318318

319319
For a complete list of the default mappings, see the
320-
`BsonTypeClassMap <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/BsonTypeClassMap.html>`__ API Documentation.
320+
`BsonTypeClassMap <{+api-root+}/bson/org/bson/codecs/BsonTypeClassMap.html>`__ API Documentation.
321321

322322
For an example of how the ``Document`` class uses ``BsonTypeClassMap``, see
323323
the driver source code for the following classes:
@@ -403,5 +403,5 @@ see the following API Documentation:
403403

404404
- `withCodecRegistry() <{+driver-api+}/MongoCollection.html#withCodecRegistry(org.bson.codecs.configuration.CodecRegistry)>`__
405405
- `MongoClientSettings.getDefaultCodecRegistry() <{+core-api+}/MongoClientSettings.html#getDefaultCodecRegistry()>`__
406-
- `Codec <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/Codec.html>`__
407-
- `CodecProvider <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/configuration/CodecProvider.html>`__
406+
- `Codec <{+api-root+}/bson/org/bson/codecs/Codec.html>`__
407+
- `CodecProvider <{+api-root+}/bson/org/bson/codecs/configuration/CodecProvider.html>`__

‎source/data-formats/document-data-format-bson.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ MongoDB and BSON
3838

3939
The MongoDB Java Driver, which uses the BSON library, allows you to work
4040
with BSON data by using one of the object types that implements the
41-
`BSON interface <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/conversions/Bson.html>`__,
41+
`BSON interface <{+api-root+}/bson/org/bson/conversions/Bson.html>`__,
4242
including:
4343

44-
- `Document <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/Document.html>`__ (BSON library package)
45-
- `BsonDocument <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BsonDocument.html>`__ (BSON library package)
46-
- `RawBsonDocument <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/RawBsonDocument.html>`__ (BSON library package)
47-
- `JsonObject <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/JsonObject.html>`__ (BSON library package)
44+
- `Document <{+api-root+}/bson/org/bson/Document.html>`__ (BSON library package)
45+
- `BsonDocument <{+api-root+}/bson/org/bson/BsonDocument.html>`__ (BSON library package)
46+
- `RawBsonDocument <{+api-root+}/bson/org/bson/RawBsonDocument.html>`__ (BSON library package)
47+
- `JsonObject <{+api-root+}/bson/org/bson/json/JsonObject.html>`__ (BSON library package)
4848
- `BasicDBObject <{+core-api+}/BasicDBObject.html>`__ (Java Driver package)
4949

5050
For more information about using these object types, see our

‎source/data-formats/document-data-format-extended-json.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ resources:
8686

8787
- `JSON RFC <https://tools.ietf.org/html/rfc7159>`__ Official Documentation
8888
- :manual:`MongoDB Extended JSON </reference/mongodb-extended-json/>` Server Manual Entry
89-
- `BsonBinary <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/BsonBinary.html>`__ API Documentation
89+
- `BsonBinary <{+api-root+}/bson/org/bson/BsonBinary.html>`__ API Documentation
9090
- `Extended JSON specification <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst>`__ GitHub Documentation
9191

9292
Extended JSON Examples
@@ -226,7 +226,7 @@ an Extended JSON string into Java objects:
226226

227227

228228
For more information, see the `JsonReader
229-
<https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/JsonReader.html>`__ API Documentation.
229+
<{+api-root+}/bson/org/bson/json/JsonReader.html>`__ API Documentation.
230230

231231
Write Extended JSON
232232
-------------------
@@ -296,9 +296,9 @@ by passing the ``outputMode()`` builder method the ``JsonMode.EXTENDED`` constan
296296
For more information about the methods and classes mentioned in this section,
297297
see the following API Documentation:
298298

299-
- `JsonWriter <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/JsonWriter.html>`__
300-
- `JsonWriterSettings <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/JsonWriterSettings.html>`__
301-
- `outputMode() <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/JsonWriterSettings.Builder.html#outputMode(org.bson.json.JsonMode)>`__
299+
- `JsonWriter <{+api-root+}/bson/org/bson/json/JsonWriter.html>`__
300+
- `JsonWriterSettings <{+api-root+}/bson/org/bson/json/JsonWriterSettings.html>`__
301+
- `outputMode() <{+api-root+}/bson/org/bson/json/JsonWriterSettings.Builder.html#outputMode(org.bson.json.JsonMode)>`__
302302

303303
Custom BSON Type Conversion
304304
---------------------------
@@ -346,5 +346,5 @@ Without specifying the converters, the Relaxed mode JSON output resembles the fo
346346
For more information about the methods and classes mentioned in this section,
347347
see the following API Documentation:
348348

349-
- `Converter <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/Converter.html>`__
350-
- `JsonWriterSettings.Builder <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/json/JsonWriterSettings.Builder.html>`__
349+
- `Converter <{+api-root+}/bson/org/bson/json/Converter.html>`__
350+
- `JsonWriterSettings.Builder <{+api-root+}/bson/org/bson/json/JsonWriterSettings.Builder.html>`__

‎source/data-formats/document-data-format-pojo.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,14 +197,14 @@ The example prints the following output:
197197
For more information about the methods and classes mentioned in this section,
198198
see the following API documentation:
199199

200-
- `CodecRegistry <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistry.html>`__
200+
- `CodecRegistry <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistry.html>`__
201201
- `TDocument <{+driver-api+}/MongoCollection.html>`__
202-
- `PojoCodecProvider <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/pojo/PojoCodecProvider.html>`__
203-
- `automatic(true) <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/pojo/PojoCodecProvider.Builder.html#automatic(boolean)>`__
204-
- `PojoCodecProvider.Builder <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/pojo/PojoCodecProvider.Builder.html>`__
205-
- `fromRegistries() <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__
202+
- `PojoCodecProvider <{+api-root+}/bson/org/bson/codecs/pojo/PojoCodecProvider.html>`__
203+
- `automatic(true) <{+api-root+}/bson/org/bson/codecs/pojo/PojoCodecProvider.Builder.html#automatic(boolean)>`__
204+
- `PojoCodecProvider.Builder <{+api-root+}/bson/org/bson/codecs/pojo/PojoCodecProvider.Builder.html>`__
205+
- `fromRegistries() <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromRegistries(org.bson.codecs.configuration.CodecRegistry...)>`__
206206
- `getDefaultCodecRegistry() <{+core-api+}/MongoClientSettings.html?is-external=true#getDefaultCodecRegistry()>`__
207-
- `fromProviders() <https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/bson/org/bson/codecs/configuration/CodecRegistries.html#fromProviders(org.bson.codecs.configuration.CodecProvider...)>`__
207+
- `fromProviders() <{+api-root+}/bson/org/bson/codecs/configuration/CodecRegistries.html#fromProviders(org.bson.codecs.configuration.CodecProvider...)>`__
208208

209209
Frequently Asked Questions
210210
--------------------------

0 commit comments

Comments
 (0)