Skip to content

Commit 9c7f9f5

Browse files
committed
docs(README): various style fixes
1 parent 819005e commit 9c7f9f5

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ const docs = await Artist().find(...).where(...);
145145
- [setOptions](#setoptionsoptions)
146146
- [setTraceFunction](#settracefunctionfunc)
147147
- [mquery.setGlobalTraceFunction](#mquerysetglobaltracefunctionfunc)
148-
- [mquery.canMerge](#mquerycanmerge)
148+
- [mquery.canMerge](#mquerycanmergeconditions)
149149
- [mquery.use$geoWithin](#mqueryusegeowithin)
150150

151151
### find()
@@ -214,7 +214,7 @@ await mquery().update(match, updateDocument)
214214
await mquery().update(match, updateDocument, options)
215215
```
216216

217-
##### the update document
217+
#### the update document
218218

219219
All paths passed that are not `$atomic` operations will become `$set` ops. For example:
220220

@@ -230,7 +230,7 @@ await collection.update({ _id: id }, { $set: { title: 'words' } })
230230

231231
This behavior can be overridden using the `overwrite` option (see below).
232232

233-
##### options
233+
#### options
234234

235235
Options are passed to the `setOptions()` method.
236236

@@ -286,7 +286,7 @@ Declares this query a _findAndModify_ with update query. Optionally pass a match
286286

287287
When executed, the first matching document (if found) is modified according to the update document and passed back.
288288

289-
##### options
289+
#### options
290290

291291
Options are passed to the `setOptions()` method.
292292

@@ -318,7 +318,7 @@ Optionally pass a match clause, options.
318318

319319
When executed, the first matching document (if found) is modified according to the update document, removed from the collection and passed as a result.
320320

321-
##### options
321+
#### options
322322

323323
Options are passed to the `setOptions()` method.
324324

@@ -698,7 +698,7 @@ mquery().select({ name: 1, address: 1, _id: 0 })
698698
mquery().select('name address -_id')
699699
```
700700

701-
##### String syntax
701+
#### String syntax
702702

703703
When passing a string, prefixing a path with `-` will flag that path as excluded. When a path does not have the `-` prefix, it is included.
704704

@@ -942,7 +942,6 @@ query.maxTimeMS(100)
942942

943943
[MongoDB documentation](http://docs.mongodb.org/manual/reference/method/cursor.maxTimeMS/)
944944

945-
946945
### skip()
947946

948947
Specifies the skip option.
@@ -996,7 +995,7 @@ mquery().read('n') // same as nearest
996995
mquery().setReadPreference('primary') // alias of .read()
997996
```
998997

999-
##### Preferences:
998+
#### Preferences:
1000999

10011000
- `primary` - (default) Read from primary only. Operations will produce an error if primary is unavailable. Cannot be combined with tags.
10021001
- `secondary` - Read from secondary if available, otherwise error.
@@ -1012,7 +1011,7 @@ Aliases
10121011
- `sp` secondaryPreferred
10131012
- `n` nearest
10141013

1015-
##### Preference Tags:
1014+
#### Preference Tags:
10161015

10171016
To keep the separation of concerns between `mquery` and your driver
10181017
clean, `mquery#read()` no longer handles specifying a second `tags` argument as of version 0.5.
@@ -1029,7 +1028,6 @@ mquery(...).read(preference).exec();
10291028

10301029
Read more about how to use read preferences [here](http://docs.mongodb.org/manual/applications/replication/#read-preference) and [here](http://mongodb.github.com/node-mongodb-native/driver-articles/anintroductionto1_1and2_2.html#read-preferences).
10311030

1032-
10331031
### readConcern()
10341032

10351033
Sets the readConcern option for the query.
@@ -1061,7 +1059,7 @@ mquery().readConcern('s')
10611059
mquery().r('s')
10621060
```
10631061

1064-
##### Read Concern Level:
1062+
#### Read Concern Level:
10651063

10661064
- `local` - The query returns from the instance with no guarantee guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back). (MongoDB 3.2+)
10671065
- `available` - The query returns from the instance with no guarantee guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back). (MongoDB 3.6+)
@@ -1104,7 +1102,7 @@ mquery().writeConcern('tagSetName') // if the tag set is 'm', use .writeConcern(
11041102
mquery().w(1) // w is alias of writeConcern
11051103
```
11061104

1107-
##### Write Concern:
1105+
#### Write Concern:
11081106

11091107
writeConcern({ w: `<value>`, j: `<boolean>`, wtimeout: `<number>` }`)
11101108

@@ -1236,15 +1234,15 @@ Sets query options.
12361234
mquery().setOptions({ collection: coll, limit: 20 })
12371235
```
12381236

1239-
##### options
1237+
#### options
12401238

12411239
- [tailable](#tailable) *
12421240
- [sort](#sort) *
12431241
- [limit](#limit) *
12441242
- [skip](#skip) *
12451243
- [maxScan](#maxscan) *
12461244
- [maxTime](#maxtime) *
1247-
- [batchSize](#batchSize) *
1245+
- [batchSize](#batchsize) *
12481246
- [comment](#comment) *
12491247
- [snapshot](#snapshot) *
12501248
- [hint](#hint) *
@@ -1345,7 +1343,7 @@ Read the debug module documentation for more details.
13451343

13461344
## General compatibility
13471345

1348-
#### ObjectIds
1346+
### ObjectIds
13491347

13501348
`mquery` clones query arguments before passing them to a `collection` method for execution.
13511349
This prevents accidental side-affects to the objects you pass.

0 commit comments

Comments
 (0)