Skip to content

Commit 7e9f05a

Browse files
committed
(DOCSP-12280): Convert generic admonitions to named admonitions
1 parent e479377 commit 7e9f05a

File tree

132 files changed

+253
-474
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+253
-474
lines changed

source/android/access-custom-user-data.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,7 @@ method on the ``User`` object of a logged in user:
8585
}
8686
});
8787

88-
.. admonition:: Custom Data May Be Stale
89-
:class: warning
88+
.. warning:: Custom Data May Be Stale
9089

9190
{+backend+} does not dynamically update the value of
9291
:java-sdk:`User.customData() <io/realm/mongodb/User.html#getCustomData-->`

source/android/collections.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,7 @@ collection in your view class, then read the results
7878
collection as needed without having to refresh it or
7979
validate that it is up-to-date.
8080

81-
.. admonition:: Indexes may change
82-
:class: important
81+
.. important:: Indexes may change
8382

8483
Since results update themselves automatically, do not
8584
store the positional index of an object in the collection
@@ -159,8 +158,7 @@ are determined by a query.
159158

160159
.. _android-collection-type-for-implicit-inverse-relationships:
161160

162-
.. admonition:: Inverse one-to-many relationship property exception
163-
:class: note
161+
.. note:: Inverse one-to-many relationship property exception
164162

165163
Since {+client-database+} automatically determines the contents of
166164
:ref:`implicit inverse relationship

source/android/embedded-objects.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ exist as an independent Realm object. Realm automatically deletes
2929
embedded objects if their parent object is deleted or when overwritten
3030
by a new embedded object instance.
3131

32-
.. admonition:: Realm Uses Cascading Deletes for Embedded Objects
33-
:class: note
32+
.. note:: Realm Uses Cascading Deletes for Embedded Objects
3433

3534
When you delete a Realm object, Realm automatically deletes any
3635
embedded objects referenced by that object. Any objects that your

source/android/init-realmclient.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ Pass the {+app+} ID for your {+app+}, which you can find in the {+ui+}.
4343
Realm.init(this) // `this` is a Context, typically an Application or Activity
4444
val app: App = App(AppConfiguration.Builder(appID).build())
4545

46-
.. admonition:: Initialize the App before Creating an Instance
47-
:class: important
46+
.. important:: Initialize the App before Creating an Instance
4847

4948
You must initialize your {+service-short+} app connection with
5049
``Realm.init()`` before creating any instance of an ``App``.

source/android/install.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ Installation
3636
{+service+} supports the Gradle build system. Follow these steps
3737
to add the {+service+} Android SDK to your project.
3838

39-
.. admonition:: A note on ProGuard
40-
:class: note
39+
.. note:: A note on ProGuard
4140

4241
Because {+service+} provides a ProGuard configuration as part
4342
of the {+service+} library, you do not need to add any

source/android/notifications.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,7 @@ indices:
101101
- The indices of the objects that were inserted.
102102
- The indices of the objects that were modified.
103103

104-
.. admonition:: Order Matters
105-
:class: important
104+
.. important:: Order Matters
106105

107106
In collection notification handlers, always apply changes
108107
in the following order: deletions, insertions, then

source/android/query-engine.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ An **expression** consists of one of the following:
4040
- An operator and up to two argument expression(s).
4141
- A literal string, number, or date.
4242

43-
.. admonition:: About the examples on this page
44-
:class: note
43+
.. note:: About the examples on this page
4544

4645
The examples in this page use a simple data set for a
4746
task list app. The two Realm object types are ``Project``

source/android/quick-start.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ integrated into your app. Before you begin, ensure you have:
2222
- :ref:`Enabled {+sync+} <enable-sync>`
2323
- :ref:`Installed the Android SDK <android-install>`
2424

25-
.. admonition:: Check Out the Tutorial
26-
:class: note
25+
.. note:: Check Out the Tutorial
2726

2827
This page contains only the essential information that you need to set up a
2928
MongoDB Realm application. If you prefer to follow a guided tutorial that
@@ -85,8 +84,7 @@ access your {+app+} using your {+app+} ID. You can find your {+app+} ID in the
8584
val app: App = App(AppConfiguration.Builder(appID)
8685
.build())
8786

88-
.. admonition:: Android Studio Errors?
89-
:class: note
87+
.. note:: Android Studio Errors?
9088

9189
If Android Studio does not recognize the ``Realm``, ``App``, or
9290
``AppConfiguration`` types, there could be a problem with the

source/android/reads.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ All query, filter, and sort operations return a
4141
collections are live, meaning they always contain the latest
4242
results of the associated query.
4343

44-
.. admonition:: About the examples on this page
45-
:class: note
44+
.. note:: About the examples on this page
4645

4746
The examples on this page use the data model of a project
4847
management app that has two {+service-short+} object types: ``Project``
@@ -245,4 +244,3 @@ Summary
245244
- To read from {+client-database+}, first get all objects of a certain type from the {+realm+}, then filter using the query engine, then (optionally) sort the results.
246245
- When you read, the results are not copies. Instead, through memory mapping, results point directly to the version on disk.
247246
- Queries are lazily-evaluated.
248-

source/android/realms.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,7 @@ in the {+realm+} configuration when you open a {+realm+}. If a client
112112
application does not specify a version number when it opens a {+realm+} then
113113
the {+realm+} defaults to version ``0``.
114114

115-
.. admonition:: Increment Versions Monotonically
116-
:class: important
115+
.. important:: Increment Versions Monotonically
117116

118117
:ref:`Migrations <android-client-migrations>` must update
119118
a {+realm+} to a higher schema version.

source/android/sync-data.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@ The syntax to :ref:`read <android-realm-database-reads>`, :ref:`write
6464
synced {+realm+} is identical to the syntax for non-synced {+realms+}. While you work with
6565
local data, a background thread efficiently integrates, uploads, and downloads changesets.
6666

67-
.. admonition:: When Using Sync, Avoid Writes on the Main Thread
68-
:class: important
67+
.. important:: When Using Sync, Avoid Writes on the Main Thread
6968

7069
The fact that {+service-short+} performs sync integrations on a background thread means
7170
that if you write to your {+realm+} on the main thread, there's a small chance your UI

source/android/threading.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,7 @@ spawned them stays open. Therefore, avoid closing the live
175175
{+realm+} until all threads are done with the frozen objects.
176176
You can close frozen {+realm+} before the live {+realm+} is closed.
177177

178-
.. admonition:: On caching frozen objects
179-
:class: important
178+
.. important:: On caching frozen objects
180179

181180
Caching too many frozen objects can have a negative
182181
impact on the {+realm+} file size. "Too many" depends on your
@@ -243,8 +242,7 @@ relevant part of the tree. Likewise, the {+realm+}'s root
243242
pointer will point to the original version until the new
244243
version is guaranteed to be valid.
245244

246-
.. admonition:: Diagram
247-
:class: note
245+
.. note:: Diagram
248246

249247
The following diagram illustrates the commit process:
250248

source/android/writes.txt

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ words, a transaction is *all or nothing*: either all of the
2828
operations in the transaction succeed or none of the
2929
operations in the transaction take effect.
3030

31-
.. admonition:: Remember
32-
:class: note
33-
31+
.. note::
32+
3433
All writes must happen in a transaction.
3534

3635
A {+realm+} allows only one open transaction at a time. {+client-database+}
@@ -73,8 +72,7 @@ the code in the callback throws an exception when {+client-database+} runs
7372
it, {+client-database+} cancels the transaction. Otherwise, {+client-database+} commits
7473
the transaction immediately after the callback.
7574

76-
.. admonition:: Concurrency Concerns
77-
:class: important
75+
.. important:: Concurrency Concerns
7876

7977
Since transactions block each other, it is best to avoid
8078
opening transactions on both the UI thread and a
@@ -260,8 +258,7 @@ transaction.
260258
With the Java SDK, call ``deleteFromRealm()`` on the
261259
instance itself.
262260

263-
.. admonition:: Do not use objects after delete
264-
:class: important
261+
.. important:: Do not use objects after delete
265262

266263
{+client-database+} throws an error if you try to use an object after
267264
it has been deleted.

source/authentication.txt

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ accepts JSON web tokens signed by the external system and
6262
the :doc:`Custom Function </authentication/custom-function>`
6363
provider allows you to define custom logic in a :term:`{+service-short+} Function`.
6464

65-
.. admonition:: User Authentication is Required
66-
:class: important
65+
.. important:: User Authentication is Required
6766

6867
Every application must have at least one authentication provider
6968
configured and enabled before any client application can successfully
@@ -86,8 +85,7 @@ allows you to associate each user with :doc:`custom data
8685
</users/enable-custom-user-data>` stored in a collection
8786
of your :term:`linked {+atlas+} data source <data source>`.
8887

89-
.. admonition:: Link Multiple Identities to One User Account
90-
:class: note
88+
.. note:: Link Multiple Identities to One User Account
9189

9290
When a user authenticates with a provider for the first
9391
time, {+backend+} creates a new account and associates the
@@ -156,8 +154,7 @@ to circumvent rules and queries that need :doc:`unrestricted
156154
access </mongodb/service-limitations>` to MongoDB
157155
CRUD and aggregation operations.
158156

159-
.. admonition:: Security Warning
160-
:class: important
157+
.. important:: Security Warning
161158

162159
Rules do not apply to the system user, which means that
163160
Functions and webhooks that run as the :term:`system user`

source/authentication/anonymous.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ different authentication provider. See :doc:`linking
4545
</authentication/linking>` for more information on how to accomplish
4646
this.
4747

48-
.. admonition:: Anonymous user expiration
49-
:class: important
48+
.. important:: Anonymous user expiration
5049

5150
{+service-short+} may delete an Anonymous user object that is 90 days old (or
5251
older). When an account is deleted, it is not recoverable and any

source/authentication/custom-function.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ with the Custom Function provider. You can use the function to
3030
coordinate with an external authentication system and/or use data that
3131
you store in MongoDB to identify and authenticate users.
3232

33-
.. admonition:: Validate and Authenticate Custom Function Users
34-
:class: important
33+
.. important:: Validate and Authenticate Custom Function Users
3534

3635
{+service-short+} does not perform any data validation or authentication
3736
checks for the Custom Function provider. Make sure that you validate

source/authentication/email-password.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@ confirmation email:
127127
if omitted, {+service-short+} uses a default subject line instead. Custom email
128128
confirmation subjects can contain a maximum of 256 characters.
129129

130-
.. admonition:: Use Deep Links in Mobile Apps
131-
:class: note
130+
.. note:: Use Deep Links in Mobile Apps
132131

133132
Mobile applications can handle email confirmation directly in the app
134133
by configuring `deep linking <https://developer.android.com/training/app-links/deep-linking.html>`_
@@ -303,8 +302,7 @@ password reset email:
303302
subject line instead. Custom password reset subjects can contain a
304303
maximum of 256 characters.
305304

306-
.. admonition:: Use Deep Links in Mobile Apps
307-
:class: note
305+
.. note:: Use Deep Links in Mobile Apps
308306

309307
Mobile applications can handle password resets directly in the app
310308
by configuring `deep linking

source/billing.txt

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ how much you pay each month:
3131
- :ref:`Data Transfer <billing-data-transfer>`, which measures the amount of
3232
data that {+service+} sends to external services and client applications.
3333

34-
.. admonition:: Track Your Usage
35-
:class: note
34+
.. note:: Track Your Usage
3635

3736
You can track an application's usage for the current month from the
3837
application dashboard in the {+ui+}.
@@ -111,8 +110,7 @@ types of request:
111110
hours of :ref:`compute <billing-compute>` **or** 10,000 hours of :ref:`sync
112111
<billing-sync>` runtime (whichever occurs first)
113112

114-
.. admonition:: Estimate Your Usage
115-
:class: admonition-example
113+
.. example:: Estimate Your Usage
116114

117115
Consider answering the following questions to help estimate the number of
118116
requests that your application will receive each month.
@@ -154,8 +152,7 @@ and increases by 1 for every 32MB of memory that a given request uses.
154152
hours of :ref:`compute <billing-compute>` **or** 10,000 hours of :ref:`sync
155153
<billing-sync>` runtime (whichever occurs first)
156154

157-
.. admonition:: Estimate Your Usage
158-
:class: admonition-example
155+
.. example:: Estimate Your Usage
159156

160157
Consider answering the following questions to help estimate the amount of
161158
compute time that your application will use each month.
@@ -192,8 +189,7 @@ millisecond of sync runtime per user.
192189
hours of :ref:`compute <billing-compute>` **or** 10,000 hours of :ref:`sync
193190
<billing-sync>` runtime (whichever occurs first)
194191

195-
.. admonition:: Estimate Your Usage
196-
:class: admonition-example
192+
.. example:: Estimate Your Usage
197193

198194
Consider answering the following questions to help estimate the amount of
199195
sync time that your application will use each month.
@@ -218,14 +214,12 @@ set rate for each gigabyte of data egress.
218214

219215
**Free Tier Threshold:** 10GB
220216

221-
.. admonition:: MongoDB Atlas Data Transfer
222-
:class: note
217+
.. note:: MongoDB Atlas Data Transfer
223218

224219
{+service+} does not bill for data transfer to and from a linked
225220
MongoDB Atlas data source.
226221

227-
.. admonition:: Estimate Your Usage
228-
:class: admonition-example
222+
.. example:: Estimate Your Usage
229223

230224
Consider answering the following questions to help estimate the amount of
231225
data that your application will transfer each month.
@@ -293,8 +287,7 @@ one month:
293287
* - **TOTAL**
294288
- $55.60 (requests) + $0.33 (sync) + $3.98 (data transfer) = **$59.91 / month**
295289

296-
.. admonition:: Free Tier Usage
297-
:class: note
290+
.. note:: Free Tier Usage
298291

299292
The way that free tier usage affects your bill depends on your consumption
300293
each month. For this example, we assume that all requests and activity are
@@ -367,8 +360,7 @@ one month:
367360
* - **TOTAL**
368361
- $0.44 (requests) + $0.47 (compute) + $0 (data transfer) = **$0.91 / month**
369362

370-
.. admonition:: Free Tier Usage
371-
:class: note
363+
.. note:: Free Tier Usage
372364

373365
The way that free tier usage affects your bill depends on your consumption
374366
each month. For this example, we assume that all requests and activity are
@@ -444,8 +436,7 @@ restaurants. The app has the following usage:
444436
* - **TOTAL**
445437
- $0.48 (requests) + $0.34 (compute) + $0 (data transfer) = **$0.82 / month**
446438

447-
.. admonition:: Free Tier Usage
448-
:class: note
439+
.. note:: Free Tier Usage
449440

450441
The way that free tier usage affects your bill depends on your consumption
451442
each month. For this example, we assume that all requests and activity are

source/dotnet/collections.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ collection in your view class, then read the results
7777
collection as needed without having to refresh it or
7878
validate that it is up-to-date.
7979

80-
.. admonition:: Indexes may change
81-
:class: important
80+
.. important:: Indexes may change
8281

8382
Since results update themselves automatically, do not
8483
store the positional index of an object in the collection
@@ -158,8 +157,7 @@ are determined by a query.
158157

159158
.. _dotnet-collection-type-for-implicit-inverse-relationships:
160159

161-
.. admonition:: Inverse one-to-many relationship property exception
162-
:class: note
160+
.. note:: Inverse one-to-many relationship property exception
163161

164162
Since {+client-database+} automatically determines the contents of
165163
:ref:`implicit inverse relationship

source/dotnet/notifications.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,7 @@ indices:
9494
- The indices of the objects that were inserted.
9595
- The indices of the objects that were modified.
9696

97-
.. admonition:: Order Matters
98-
:class: important
97+
.. important:: Order Matters
9998

10099
In collection notification handlers, always apply changes
101100
in the following order: deletions, insertions, then

source/dotnet/query-engine.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ An **expression** consists of one of the following:
4040
- An operator and up to two argument expression(s).
4141
- A literal string, number, or date.
4242

43-
.. admonition:: About the examples on this page
44-
:class: note
43+
.. note:: About the examples on this page
4544

4645
The examples in this page use a simple data set for a
4746
task list app. The two Realm object types are ``Project``

source/dotnet/reads.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ All query, filter, and sort operations return a
4141
collections are live, meaning they always contain the latest
4242
results of the associated query.
4343

44-
.. admonition:: About the examples on this page
45-
:class: note
44+
.. note:: About the examples on this page
4645

4746
The examples on this page use the data model of a project
4847
management app that has two {+service-short+} object types: ``Project``
@@ -221,4 +220,3 @@ Summary
221220
- To read from {+client-database+}, first get all objects of a certain type from the {+realm+}, then filter using the query engine, then (optionally) sort the results.
222221
- When you read, the results are not copies. Instead, through memory mapping, results point directly to the version on disk.
223222
- Queries are lazily-evaluated.
224-

0 commit comments

Comments
 (0)