Skip to content

Commit 4f024eb

Browse files
committed
CBG-4503 fix small grammar issue
1 parent 0afb808 commit 4f024eb

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

db/attachment_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -875,7 +875,7 @@ func TestMigrateBodyAttachments(t *testing.T) {
875875
defer db.Close(ctx)
876876
collection, ctx := GetSingleDatabaseCollectionWithUser(ctx, t, db)
877877

878-
// Update the doc with a the same body as rev 3-a, and make sure attachments are migrated.
878+
// Update the doc with the same body as rev 3-a, and make sure attachments are migrated.
879879
newBody := Body{
880880
"test": true,
881881
BodyRev: "3-a",

docs/api/components/schemas.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,7 @@ Retrieved-replication:
697697
- localWins
698698
- custom
699699
custom_conflict_resolver:
700-
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new documents body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an Enterprise Edition only feature.\n"
700+
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new document's body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an Enterprise Edition only feature.\n"
701701
type: string
702702
default: none
703703
purge_on_removal:
@@ -925,7 +925,7 @@ Replication:
925925
- localWins
926926
- custom
927927
custom_conflict_resolver:
928-
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new documents body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an Enterprise Edition only feature.\n"
928+
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new document's body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an Enterprise Edition only feature.\n"
929929
type: string
930930
default: none
931931
purge_on_removal:

docs/api/paths/admin/db-_compact.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ post:
2525
- $ref: ../../components/parameters.yaml#/compact-type
2626
- name: action
2727
in: query
28-
description: Defines whether the a compact operation is being started or stopped.
28+
description: Defines whether the compact operation is being started or stopped.
2929
schema:
3030
type: string
3131
default: start

docs/api/paths/admin/keyspace-_raw-docid.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ parameters:
1111
get:
1212
summary: Get a document with the corresponding metadata
1313
description: |-
14-
Returns the a documents latest revision with its metadata.
14+
Returns a document's latest revision with its metadata.
1515
1616
Note: The direct use of this endpoint is unsupported. The sync metadata is maintained internally by Sync Gateway and its structure can change. It should not be used to drive business logic of applications since the response to the `/{db}/_raw/{id}` endpoint can change at any time.
1717
@@ -23,7 +23,7 @@ get:
2323
- $ref: ../../components/parameters.yaml#/include_doc
2424
- name: redact
2525
in: query
26-
description: This redacts sensitive parts of the response. Cannot be used when `include_docs=true`
26+
description: This redacts sensitive parts of the response. Cannot be used when `include_doc=true`
2727
schema:
2828
type: boolean
2929
responses:
@@ -72,7 +72,7 @@ get:
7272
description: The document CAS (Concurrent Document Mutations) number used for document locking.
7373
type: string
7474
value_crc32c:
75-
description: The documents CRC32 number.
75+
description: The document's CRC32 number.
7676
type: string
7777
channel_set:
7878
description: The channels the document has been in.

0 commit comments

Comments
 (0)