Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-27679:Make placeholder text consistent #108

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ applications:

.. code-block:: csharp

var client = new MongoClient("<connection string>");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: I think <connection string> is the best placeholder, suggesting that you change the placeholder to this in all locations.

var client = new MongoClient("<your MongoDB URI>");

Create a client once for each process, and reuse it for all
operations. It is a common mistake to create a new client for each
Expand Down
5 changes: 3 additions & 2 deletions source/fundamentals/logging.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ logs all debug messages to the console:
b.SetMinimumLevel(LogLevel.Debug);
});

var settings = MongoClientSettings.FromConnectionString("<your connection string>");
var settings = MongoClientSettings.FromConnectionString("<your
MongoDB URI>");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I: make sure you revert the line breaks that your formatter creates when it comes to code examples.

Suggested change
var settings = MongoClientSettings.FromConnectionString("<your
MongoDB URI>");
var settings = MongoClientSettings.FromConnectionString("<your MongoDB URI>");

settings.LoggingSettings = new LoggingSettings(loggerFactory);
var client = new MongoClient(settings);

Expand Down Expand Up @@ -141,7 +142,7 @@ to a ``LoggerFactory``.
b.AddSimpleConsole();
});

var settings = MongoClientSettings.FromConnectionString("<your connection string>");
var settings = MongoClientSettings.FromConnectionString("<your MongoDB URI>");
settings.LoggingSettings = new LoggingSettings(loggerFactory);
var client = new MongoClient(settings);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
using MongoDB.Bson;

// Replace the placeholder with your Atlas connection string
const string connectionUri = "<connection string>";
const string connectionUri = "<your MongoDB URI>";

var settings = MongoClientSettings.FromConnectionString(connectionUri);

Expand Down
2 changes: 1 addition & 1 deletion source/quick-start.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ code.

.. code-block:: bash

export MONGODB_URI='<your MongoDB connection string>'
export MONGODB_URI='<your MongoDB URI>'

.. important::

Expand Down
2 changes: 1 addition & 1 deletion source/usage-examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ your MongoDB instance:
.. code-block:: csharp

// Replace the following with your MongoDB deployment's connection string.
private static string _mongoConnectionString = "<Your MongoDB URI>";
private static string _mongoConnectionString = "<your MongoDB URI>";

For more information about connecting to your MongoDB instance, see the
:ref:`Connection Guide <csharp-connection>`.