Skip to content

Commit 71b03f6

Browse files
author
Sam Kleinman
committed
DOCS-2537: edit internal markers on some commands
1 parent 38f00eb commit 71b03f6

File tree

5 files changed

+17
-15
lines changed

5 files changed

+17
-15
lines changed

source/reference/command/captrunc.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ Definition
99

1010
.. dbcommand:: captrunc
1111

12-
Truncates capped collections. :dbcommand:`captrunc` is an internal
13-
command to support testing that takes the following form:
12+
:dbcommand:`captrunc` is a command that truncates capped
13+
collections for diagnostic and testing purposes and is not part of
14+
the stable client facing API. The command takes the following form:
1415

1516
.. code-block:: javascript
1617

@@ -23,7 +24,6 @@ Definition
2324
.. |dbcommand| replace:: :dbcommand:`captrunc`
2425
.. include:: /includes/note-enabletestcommands.rst
2526

26-
2727
Examples
2828
--------
2929

source/reference/command/dbHash.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ dbHash
66

77
.. dbcommand:: dbHash
88

9-
:dbcommand:`dbHash` is an internal command.
9+
:dbcommand:`dbHash` is a command that supports :term:`config
10+
servers <config server>` and is not part of the stable client
11+
facing API.
1012

1113
.. slave-ok, read-lock

source/reference/command/diagLogging.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ diagLogging
66

77
.. dbcommand:: diagLogging
88

9-
:dbcommand:`diagLogging` is an internal command.
9+
:dbcommand:`diagLogging` is a command that captures additional data
10+
for diagnostic purposes and is not part of the stable client
11+
facing API.
1012

11-
.. warning::
12-
13-
This command obtains a write lock on the affected database and
14-
will block other operations until it has completed.
13+
:dbcommand:`diaglogging` obtains a write lock on the affected database and
14+
will block other operations until it completes.
1515

1616
.. write-lock, slave-ok,

source/reference/command/getShardVersion.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ getShardVersion
66

77
.. dbcommand:: getShardVersion
88

9-
:dbcommand:`getShardVersion` is an internal command that supports
10-
sharding functionality.
9+
:dbcommand:`getShardVersion` is a command that supports sharding
10+
functionality and is not part of the stable client facing API.
1111

1212
.. admin-only

source/reference/privilege-actions.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Sharding Actions
238238

239239
.. authaction:: getShardVersion
240240

241-
Provides access to the internal :dbcommand:`getShardVersion` command.
241+
Provides access to the :dbcommand:`getShardVersion` command.
242242

243243
.. authaction:: listShards
244244

@@ -366,23 +366,23 @@ Diagnostic Actions
366366

367367
.. authaction:: connPoolStats
368368

369-
Provides access to the internal :dbcommand:`connPoolStats` command.
369+
Provides access to the :dbcommand:`connPoolStats` command.
370370

371371
.. authaction:: cursorInfo
372372

373373
Provides access to the :dbcommand:`cursorInfo` command.
374374

375375
.. authaction:: dbHash
376376

377-
Provides access to the internal :dbcommand:`dbHash` command.
377+
Provides access to the :dbcommand:`dbHash` command.
378378

379379
.. authaction:: dbStats
380380

381381
Provides access to the :dbcommand:`dbStats` command.
382382

383383
.. authaction:: diagLogging
384384

385-
Provides access to the internal :dbcommand:`diagLogging` command.
385+
Provides access to the :dbcommand:`diagLogging` command.
386386

387387
.. authaction:: getCmdLineOpts
388388

0 commit comments

Comments
 (0)