Skip to content

Fix apiargs build warning, and make type names consistent #2387

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
arg_name: field
arg_name: param
description: |
A JavaScript function that associates or "maps" a ``value`` with a
``key`` and emits the ``key`` and value ``pair``.
Expand All @@ -9,9 +9,9 @@ name: map
operation: mapReduce
optional: false
position: 1
type: Javascript function
type: function
---
arg_name: field
arg_name: param
description: |
A JavaScript function that "reduces" to a single object all the
``values`` associated with a particular ``key``.
Expand All @@ -22,9 +22,9 @@ name: reduce
operation: mapReduce
optional: false
position: 2
type: JavaScript function
type: function
---
arg_name: field
arg_name: param
description: |
A document that specifies additional parameters to
:method:`db.collection.mapReduce()`.
Expand Down
6 changes: 3 additions & 3 deletions source/includes/apiargs-command-geoNear-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ name: spherical
operation: geoNear
optional: false
position: 3
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand Down Expand Up @@ -144,7 +144,7 @@ name: includeLocs
operation: geoNear
optional: true
position: 10
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -158,5 +158,5 @@ name: uniqueDocs
operation: geoNear
optional: true
position: 11
type: Boolean
type: boolean
...
8 changes: 4 additions & 4 deletions source/includes/apiargs-command-getLastError-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ name: j
operation: getLastError
optional: false
position: 1
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand Down Expand Up @@ -39,8 +39,8 @@ type:
---
# Commenting out to be consistent with writeConcern documentation,
# which does not include fsync. Also, with journaling
# enabled, fsync:true -> j: true
#
# enabled, fsync:true -> j: true
#
# arg_name: field
# description: |
# If ``true``, wait for :program:`mongod` to write this data to disk
Expand All @@ -51,7 +51,7 @@ type:
# operation: getLastError
# optional: false
# position: 3
# type: Boolean
# type: boolean
# ---
arg_name: field
description: |
Expand Down
10 changes: 5 additions & 5 deletions source/includes/apiargs-command-mapReduce-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ name: map
operation: mapReduce
optional: false
position: 1
type: Javascript function
type: function
---
arg_name: field
description: |
Expand All @@ -34,7 +34,7 @@ name: reduce
operation: mapReduce
optional: false
position: 2
type: JavaScript function
type: function
---
arg_name: field
description: |
Expand All @@ -46,7 +46,7 @@ name: finalize
operation: mapReduce
optional: true
position: 7
type: Javascript function
type: function
---
arg_name: field
description: |
Expand Down Expand Up @@ -146,7 +146,7 @@ name: jsMode
operation: mapReduce
optional: true
position: 9
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -158,5 +158,5 @@ name: verbose
operation: mapReduce
optional: true
position: 10
type: Boolean
type: boolean
...
4 changes: 2 additions & 2 deletions source/includes/apiargs-command-moveChunk-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ name: secondaryThrottle
operation: moveChunk
optional: true
position: 5
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -84,5 +84,5 @@ name: _waitForDelete
operation: moveChunk
optional: true
position: 7
type: Boolean
type: boolean
...
2 changes: 1 addition & 1 deletion source/includes/apiargs-command-replSetStepDown-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ name: force
operation: replSetStepDown
optional: true
position: 3
type: Boolean
type: boolean
...
4 changes: 2 additions & 2 deletions source/includes/apiargs-dbcommand-fsync-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ name: async
operation: fsync
optional: true
position: 2
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -27,5 +27,5 @@ name: lock
operation: fsync
optional: true
position: 3
type: Boolean
type: boolean
...
4 changes: 2 additions & 2 deletions source/includes/apiargs-dbcommand-rolesInfo-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ name: showPrivileges
operation: rolesInfo
optional: true
position: 2
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -37,5 +37,5 @@ name: showBuiltinRoles
operation: rolesInfo
optional: true
position: 3
type: Boolean
type: boolean
...
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ name: unique
operation: shardCollection
optional: false
position: 3
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand Down
4 changes: 2 additions & 2 deletions source/includes/apiargs-dbcommand-usersInfo-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ name: showCredentials
operation: usersInfo
optional: true
position: 2
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -30,5 +30,5 @@ name: showPrivileges
operation: usersInfo
optional: true
position: 3
type: Boolean
type: boolean
...
2 changes: 1 addition & 1 deletion source/includes/apiargs-message-audit-message-fields.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ name: atype
operation: audit
optional: false
position: 1
type: String
type: string
---
arg_name: field
description: |
Expand Down
2 changes: 1 addition & 1 deletion source/includes/apiargs-method-cursor.count-param.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ name: applySkipLimit
operation: cursor.count
optional: true
position: 1
type: Boolean
type: boolean
...
2 changes: 1 addition & 1 deletion source/includes/apiargs-method-cursor.explain-param.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ name: verbose
operation: cursor.explain
optional: true
position: 1
type: String
type: string
...
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name: background
operation: db.collection.createIndex
optional: true
position: 1
type: Boolean
type: boolean
---
arg_name: param
description: |
Expand All @@ -24,7 +24,7 @@ name: unique
operation: db.collection.createIndex
optional: true
position: 2
type: Boolean
type: boolean
---
arg_name: param
description: |
Expand Down Expand Up @@ -63,7 +63,7 @@ interface: method
name: sparse
operation: db.collection.createIndex
optional: true
type: Boolean
type: boolean
---
arg_name: param
description: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ name: remove
operation: db.collection.findAndModify
optional: false
position: 3
type: Boolean
type: boolean
---
arg_name: param
description: |
Expand All @@ -59,7 +59,7 @@ name: new
operation: db.collection.findAndModify
optional: true
position: 5
type: Boolean
type: boolean
---
arg_name: param
description: |
Expand Down Expand Up @@ -89,5 +89,5 @@ name: upsert
operation: db.collection.findAndModify
optional: true
position: 7
type: Boolean
type: boolean
...
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ optional: false
position: 1
type: string or document
---
arg_name: param
arg_name: field
interface: method
name: query
operation: db.collection.mapReduce
Expand All @@ -24,7 +24,7 @@ source:
file: apiargs-command-mapReduce-field.yaml
ref: query
---
arg_name: param
arg_name: field
interface: method
name: sort
operation: db.collection.mapReduce
Expand All @@ -34,7 +34,7 @@ source:
file: apiargs-command-mapReduce-field.yaml
ref: sort
---
arg_name: param
arg_name: field
interface: method
name: limit
operation: db.collection.mapReduce
Expand All @@ -54,9 +54,9 @@ name: finalize
operation: db.collection.mapReduce
optional: true
position: 5
type: Javascript function
type: function
---
arg_name: param
arg_name: field
interface: method
name: scope
operation: db.collection.mapReduce
Expand All @@ -66,7 +66,7 @@ source:
file: apiargs-command-mapReduce-field.yaml
ref: scope
---
arg_name: param
arg_name: field
interface: method
name: jsMode
operation: db.collection.mapReduce
Expand All @@ -76,7 +76,7 @@ source:
file: apiargs-command-mapReduce-field.yaml
ref: jsMode
---
arg_name: param
arg_name: field
interface: method
name: verbose
operation: db.collection.mapReduce
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ name: full
operation: db.collection.validate
optional: true
position: 1
type: Boolean
type: boolean
...
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name: capped
operation: db.createCollection
optional: true
position: 1
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand All @@ -23,7 +23,7 @@ name: autoIndexId
operation: db.createCollection
optional: true
position: 2
type: Boolean
type: boolean
---
arg_name: field
description: |
Expand Down Expand Up @@ -88,12 +88,12 @@ description: |2

Defaults to ``false``.

.. warning::
.. warning::

Do not set ``noPadding`` if the workload includes removes or any
updates that may cause documents to grow. For more information,
see :ref:`exact-fit-allocation`.

interface: method
name: noPadding
operation: db.createCollection
Expand Down
2 changes: 1 addition & 1 deletion source/includes/apiargs-method-db.eval-param.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ name: function
operation: db.eval
optional: false
position: 1
type: JavaScript function
type: function
---
arg_name: param
description: |-
Expand Down
2 changes: 1 addition & 1 deletion source/includes/apiargs-method-db.getRoles-field.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ name: showBuiltinRoles
operation: db.getRoles
optional: true
position: 3
type: Boolean
type: boolean
...
Loading