Skip to content

Commit bcff046

Browse files
committed
Proofreading changes to the docs.
1 parent f6cf795 commit bcff046

File tree

22 files changed

+101
-88
lines changed

22 files changed

+101
-88
lines changed

Docs/Api/CSharpDriverDocs.shfbproj

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@
3131
<HelpFileFormat>HtmlHelp1, Website</HelpFileFormat>
3232
<HelpTitle>MongoDB .NET Driver API Documentation</HelpTitle>
3333
<NamespaceSummaries>
34-
<NamespaceSummaryItem name="MongoDB.Bson" isDocumented="True">The MongoDB.Bson top level namespace and its child namespaces contain the classes for managing Bson data. The top level MongoDB.Bson namespace contains the classes that represent all the basic Bson Types.</NamespaceSummaryItem>
35-
<NamespaceSummaryItem name="MongoDB.Bson.IO" isDocumented="True">The MongoDB.Bson.IO namespace contains the types that allow reading and writing of Bson data.</NamespaceSummaryItem>
36-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization" isDocumented="True">The MongoDB.Bson.Serialization namespace contains the types used in the serialization and deserialization of Bson data. It also contains the base interfaces to be implemented by the actual serializers.</NamespaceSummaryItem>
34+
<NamespaceSummaryItem name="MongoDB.Bson" isDocumented="True">The MongoDB.Bson top level namespace and its child namespaces contain the classes for managing BSON data. The top level MongoDB.Bson namespace contains the classes that represent all the basic BSON Types.</NamespaceSummaryItem>
35+
<NamespaceSummaryItem name="MongoDB.Bson.IO" isDocumented="True">The MongoDB.Bson.IO namespace contains the types that allow reading and writing of BSON data.</NamespaceSummaryItem>
36+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization" isDocumented="True">The MongoDB.Bson.Serialization namespace contains the types used in the serialization and deserialization of BSON data. It also contains the base interfaces to be implemented by the actual serializers.</NamespaceSummaryItem>
3737
<NamespaceSummaryItem name="(global)" isDocumented="False" />
38-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Attributes" isDocumented="True">The MongoDB.Bson.Serialization.Attributes namespace contains the Attributes used to control Bson serialization/deserialization.</NamespaceSummaryItem>
39-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Conventions" isDocumented="True">The various conventions used during serialization/deserialization of Bson data are represented by the types in the MongoDB.Bson.Serialization.Conventions namespace.</NamespaceSummaryItem>
40-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.IdGenerators" isDocumented="True">The various id generators used in the serialization/deserialization of Bson data are represented in this namespace.</NamespaceSummaryItem>
38+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Attributes" isDocumented="True">The MongoDB.Bson.Serialization.Attributes namespace contains the Attributes used to control BSON serialization/deserialization.</NamespaceSummaryItem>
39+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Conventions" isDocumented="True">The various conventions used during serialization/deserialization of BSON data are represented by the types in the MongoDB.Bson.Serialization.Conventions namespace.</NamespaceSummaryItem>
40+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.IdGenerators" isDocumented="True">The various id generators used in the serialization/deserialization of BSON data are represented in this namespace.</NamespaceSummaryItem>
4141
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Options" isDocumented="True">The MongoDB.Bson.Serialization.Options namespace contains the classes that represent the serialization options for specific types such as DateTime, Document etc.</NamespaceSummaryItem>
42-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various Bson and base .Net types</NamespaceSummaryItem>
42+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various BSON and base .Net types</NamespaceSummaryItem>
4343
<NamespaceSummaryItem name="MongoDB.Driver" isDocumented="True">The MongoDB.Driver namespace contains all the basic types and classes that compose the MongoDB driver. It contains the classes needed for most interactions with the database.</NamespaceSummaryItem>
4444
<NamespaceSummaryItem name="MongoDB.Driver.Builders" isDocumented="True">The MongoDB.Driver.Builders namespace contains helper classes (builders) that can be used to construct various options used in the driver.</NamespaceSummaryItem>
4545
<NamespaceSummaryItem name="MongoDB.Driver.GridFS" isDocumented="True">The classes used to interact with MongoDB GridFS are part of the MongoDB.Driver.GridFS namespace.</NamespaceSummaryItem>

Docs/landing/data/releases.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ current = "2.0.0-rc0"
2222
name = ".NET Core Driver"
2323
package = "MongoDB.Driver.Core"
2424
description = "The core driver."
25-
dependencies = ".NET Bson Library"
25+
dependencies = ".NET BSON Library"
2626
versions = "2.0.0-rc0"
2727

2828
[[drivers]]
29-
name = ".NET Bson Library"
29+
name = ".NET BSON Library"
3030
package = "MongoDB.Bson"
3131
description = "The BSON library."
3232
dependencies = ""
@@ -36,5 +36,5 @@ current = "2.0.0-rc0"
3636
name = ".NET Legacy Driver"
3737
package = "mongocsharpdriver"
3838
description = "The legacy driver."
39-
dependencies = ".NET Driver,.NET Core Driver,.NET Bson Library"
39+
dependencies = ".NET Driver,.NET Core Driver,.NET BSON Library"
4040
versions = "2.0.0-rc0,1.10.0"

Docs/landing/layouts/partials/features.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ <h2>Features</h2>
44
<dt>Driver</dt>
55
<dd>A completely async driver to talk with MongoDB.</dd>
66
<dt>Core driver</dt>
7-
<dd>The MongoDB Driver is built on top of a new core library which anyone can use to build alternative or experimental high-level APIs.</dd>
8-
<dt>Bson Library</dt>
9-
<dd>A standalone bson library, with a serialization infrastructure that you can use to build high-performance serializers.</dd>
7+
<dd>The MongoDB Driver is built on top of a new Core library which anyone can use to build alternative or experimental high-level APIs.</dd>
8+
<dt>BSON Library</dt>
9+
<dd>A standalone BSON library, with a serialization infrastructure that you can use to build high-performance serializers.</dd>
1010
</dl>

Docs/landing/layouts/partials/introduction.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ <h2>Introduction</h2>
22

33
<p>
44
The official MongoDB .NET Driver provides asynchronous interaction with MongoDB.
5-
Powering the drivers is a core library and a bson library.
5+
Powering the drivers is a Core library and a BSON library.
66
</p>

Docs/reference/content/examples/import_export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title = "Import and Export"
1010

1111
## Rewriting MongoImport and MongoExport
1212

13-
The .NET Bson library supports reading and writing JSON documents with the [`JsonReader`]({{< apiref "T_MongoDB_Bson_IO_JsonReader" >}}) and [`JsonWriter`]({{< apiref "T_MongoDB_Bson_IO_JsonWriter" >}}) classes. Both of these also handle both flavors of [MongoDB Extended JSON]({{< docsref "reference/mongodb-extended-json/" >}}).
13+
The .NET BSON library supports reading and writing JSON documents with the [`JsonReader`]({{< apiref "T_MongoDB_Bson_IO_JsonReader" >}}) and [`JsonWriter`]({{< apiref "T_MongoDB_Bson_IO_JsonWriter" >}}) classes. Both of these also handle both flavors of [MongoDB Extended JSON]({{< docsref "reference/mongodb-extended-json/" >}}).
1414

1515
Neither of these implementations are the most performant solutions, but they illustrate using multiple features of the driver together.
1616

Docs/reference/content/getting_started/connecting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This will retrieve a reference to the database named "test" in MongoDB. There is
3333

3434
## Collection
3535

36-
From here, you'll need to retrieve a reference to an [`IMongoCollection<TDocument>`]({{< apiref "T_MongoDB_Driver_IMongoCollection_1" >}}) instance, where `TDocument` is the type of document with which to work. Most likely, this will be either a [`BsonDocument`]({{< apiref "T_MongoDB_Bson_BsonDocument" >}}) or a custom class of your own. You would use a [`BsonDocument`]({{< apiref "T_MongoDB_Bson_BsonDocument" >}}) when the data you are working with is so free form that it would be difficult or impossible to define domain classes for it or because you want to handle the mapping yourself.
36+
From here, you'll need to retrieve a reference to an [`IMongoCollection<TDocument>`]({{< apiref "T_MongoDB_Driver_IMongoCollection_1" >}}) instance, where `TDocument` is the type of document with which to work. This will be either a [`BsonDocument`]({{< apiref "T_MongoDB_Bson_BsonDocument" >}}) or a custom class of your own. You would use a [`BsonDocument`]({{< apiref "T_MongoDB_Bson_BsonDocument" >}}) when the data you are working with is so free form that it would be difficult or impossible to define domain classes for it or because you want to handle the mapping yourself.
3737

3838
One constraint on your custom class is that it must contain an `Id` field. You can read more about customizing classes in the [reference guide]({{< relref "reference\bson\mapping\index.md" >}}).
3939

Docs/reference/content/getting_started/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ As the Core CLR hasn't shipped yet, we don't yet have support for it. We run com
2323

2424
[Nuget](http://www.nuget.org/) is the simplest way to get the driver. There are 4 packages available on nuget.
2525

26-
- [MongoDB.Driver](http://www.nuget.org/packages/mongodb.driver): The new driver. It is mostly void of any legacy code and should be used for all new projects. More documentation can be found in the [reference guide]({{< relref "reference\driver\index.md" >}}).
27-
- [MongoDB.Driver.Core](http://www.nuget.org/packages/mongodb.driver.core): The core of the driver and is a dependency of MongoDB.Driver. You will probably not use this package directly. More documentation can be found in the [reference guide]({{< relref "reference\driver_core\index.md" >}}).
28-
- [MongoDB.Bson](http://www.nuget.org/packages/mongodb.bson): The bson layer. It is a dependency of MongoDB.Driver.Core. It may be used by itself. More documentation can be found in the [reference guid]({{< relref "reference\bson\index.md" >}}).
26+
- [MongoDB.Driver](http://www.nuget.org/packages/mongodb.driver): The new driver. It is mostly free of any legacy code and should be used for all new projects. More documentation can be found in the [reference guide]({{< relref "reference\driver\index.md" >}}).
27+
- [MongoDB.Driver.Core](http://www.nuget.org/packages/mongodb.driver.core): The core of the driver and a dependency of MongoDB.Driver. You will probably not use this package directly. More documentation can be found in the [reference guide]({{< relref "reference\driver_core\index.md" >}}).
28+
- [MongoDB.Bson](http://www.nuget.org/packages/mongodb.bson): The BSON layer. It is a dependency of MongoDB.Driver.Core. It may be used by itself. More documentation can be found in the [reference guide]({{< relref "reference\bson\index.md" >}}).
2929
- [mongocsharpdriver](http://www.nuget.org/packages/mongocsharpdriver): The compatibility layer for those upgrading from our 1.x series. This should not be used for new projects. More information can be found in the [1.x documentation](http://mongodb.github.io/mongo-csharp-driver/1.x);
3030

3131
## Binary Installation
3232

33-
Alternatively, if you'd like to pull down binaries, you can do that from the [releases section](https://github.com/mongodb/mongo-csharp-driver/releases) on our [github repository](https://github.com/mongodb/mongo-csharp-driver) contains zip files for each release.
33+
Alternatively, if you'd like to pull down binaries, you can do that from the [releases section](https://github.com/mongodb/mongo-csharp-driver/releases) on our [github repository](https://github.com/mongodb/mongo-csharp-driver), which contains zip files for each release.
3434

35-
The assembly names mostly correlate strongly with the package names above. For new applications, you'll add the `MongoDB.Driver.dll`, `MongoDB.Driver.Core.dll`, and `MongoDB.Bson.dll`. For those working with legacy applications, you'll also want to add a reference to `MongoDB.Driver.Legacy.dll`.
35+
The assembly names mostly correlate strongly with the package names above. For new applications, you'll add references to `MongoDB.Driver.dll`, `MongoDB.Driver.Core.dll`, and `MongoDB.Bson.dll`. For those working with legacy applications, you'll also want to add a reference to `MongoDB.Driver.Legacy.dll`.

Docs/reference/content/getting_started/reading_and_writing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ var jane = new Person { Name = "Jane McJane", Age = 24, Profession = "Hacker" };
4141
await collection.InsertOneAsync(jane);
4242
```
4343

44-
After insertion, the Jane's `Id` property will contain the automatically generated identifier. For more on id generation, see the [reference guide]({{< relref "reference\bson\mapping\index.md#id-generators" >}}).
44+
After insertion, the Jane's `Id` property will contain the automatically generated identifier. For more on Id generation, see the [reference guide]({{< relref "reference\bson\mapping\index.md#id-generators" >}}).
4545

4646
## Finding a Document
4747

@@ -51,7 +51,7 @@ To find all the people who are younger than 42, use the [`Find`]({{< apiref "M_M
5151
var people = await collection.Find(x => x.Age < 42).ToListAsync();
5252
```
5353

54-
The lambda expression gets translated into the bson filter `{ Age: { $lt: 42 } }`. Not everything is support via expression trees, but most of the common operations are. See the [reference guide]({{< relref "reference\driver\definitions.md#filters" >}}) for more information.
54+
The lambda expression gets translated into the BSON filter `{ Age: { $lt: 42 } }`. Not everything is supported via expression trees, but most of the common operations are. See the [reference guide]({{< relref "reference\driver\definitions.md#filters" >}}) for more information.
5555

5656
## Updating
5757

@@ -63,7 +63,7 @@ var result = await collection.UpdateOneAsync(
6363
Builders<Person>.Update.Set(x => x.Profession, "Musician"));
6464
```
6565

66-
This will generate a filter of `{ Name: "Tom" }` and an update statement of `{ $set: { Profession: "Musician" } }`. Only one document will get updated because we used [`UpdateOneAsync`]({{< apiref "M_MongoDB_Driver_IMongoCollection_1_UpdateOneAsync" >}}) instead of [`UpdateManyAsync`]({{< apiref "M_MongoDB_Driver_IMongoCollection_1_UpdateManyAsync" >}}) even if there is more than one person named "Tom". More information on updates is available in the [reference guide]({{< relref "reference\driver\crud\writing.md#update-and-replace" >}}).
66+
This will generate a filter of `{ Name: "Tom" }` and an update specification of `{ $set: { Profession: "Musician" } }`. Only one document will get updated even if there is more than one person named "Tom" because we used [`UpdateOneAsync`]({{< apiref "M_MongoDB_Driver_IMongoCollection_1_UpdateOneAsync" >}}) instead of [`UpdateManyAsync`]({{< apiref "M_MongoDB_Driver_IMongoCollection_1_UpdateManyAsync" >}}). More information on updates is available in the [reference guide]({{< relref "reference\driver\crud\writing.md#update-and-replace" >}}).
6767

6868
Alternatively, if we want to replace a document completely, we can use the [`ReplaceOneAsync`]({{< apiref "M_MongoDB_Driver_IMongoCollection_1_ReplaceOneAsync" >}}) method. Assuming Tom's `Id` value is "550c4aa98e59471bddf68eef":
6969

Docs/reference/content/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The [Getting Started]({{< relref "getting_started\index.md" >}}) guide contains
1212

1313
## What's new in 2.0
1414

15-
The [What's New]({{< relref "what_is_new.md" >}}) contains the major new features of the driver, the largest of which is full async support.
15+
The [What's New]({{< relref "what_is_new.md" >}}) contains the major new features of the driver, the most important of which is full async support.
1616

1717

1818
## Upgrading

Docs/reference/content/reference/bson/bson.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The [`IBsonWriter`]({{< apiref "T_MongoDB_Bson_IO_IBsonWriter" >}}) interface co
5656

5757
### BSON
5858

59-
[`BsonBinaryWriter`]({{< apiref "T_MongoDB_Bson_IO_BsonBinaryWriter" >}}) is for reading binary BSON. For example, to write the document `{ a: 1 }` to a BSON file:
59+
[`BsonBinaryWriter`]({{< apiref "T_MongoDB_Bson_IO_BsonBinaryWriter" >}}) is for writing binary BSON. For example, to write the document `{ a: 1 }` to a BSON file:
6060

6161
```csharp
6262
string outputFileName; // initialize to the file to write to.

0 commit comments

Comments
 (0)