Skip to content

docs(generated): improve snippet examples #769

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.

Sign up for GitHub

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

Merged
eiri merged 1 commit into from
Oct 28, 2025
Merged

docs(generated): improve snippet examples #769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ Cloudant service = Cloudant.newInstance();

GetDbUpdatesOptions dbUpdatesOptions = new GetDbUpdatesOptions.Builder()
.feed("normal")
.heartbeat(10000)
.since("now")
.build();

Expand Down Expand Up @@ -1347,7 +1346,6 @@ Cloudant service = Cloudant.newInstance();
GetDesignDocumentOptions designDocumentOptions = new GetDesignDocumentOptions.Builder()
.db("products")
.ddoc("appliances")
.latest(true)
.build();

DesignDocument response =
Expand Down Expand Up @@ -1656,7 +1654,7 @@ Cloudant service = Cloudant.newInstance();

PostDesignDocsOptions docsOptions =
new PostDesignDocsOptions.Builder()
.attachments(true)
.descending(true)
.db("users")
.build();

Expand Down Expand Up @@ -1692,7 +1690,7 @@ AllDocsQuery query1 = new AllDocsQuery.Builder()
.build();
AllDocsQuery query2 = new AllDocsQuery.Builder()
.inclusiveEnd(true)
.key("_design/allusers")
.startKey("_design/allusers")
.skip(1)
.build();

Expand Down Expand Up @@ -1805,7 +1803,7 @@ Cloudant service = Cloudant.newInstance();

Map<String, Object> selector = Collections.singletonMap(
"address",
Collections.singletonMap("$regex", "Street"));
Collections.singletonMap("$exists", true));

PostFindOptions findOptions = new PostFindOptions.Builder()
.db("users")
Expand Down
1 change: 0 additions & 1 deletion examples/snippets/getDbUpdates/example_request.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

GetDbUpdatesOptions dbUpdatesOptions = new GetDbUpdatesOptions.Builder()
.feed("normal")
.heartbeat(10000)
.since("now")
.build();

Expand Down
1 change: 0 additions & 1 deletion examples/snippets/getDesignDocument/example_request.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
GetDesignDocumentOptions designDocumentOptions = new GetDesignDocumentOptions.Builder()
.db("products")
.ddoc("appliances")
.latest(true)
.build();

DesignDocument response =
Expand Down
2 changes: 1 addition & 1 deletion examples/snippets/postDesignDocs/example_request.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

PostDesignDocsOptions docsOptions =
new PostDesignDocsOptions.Builder()
.attachments(true)
.descending(true)
.db("users")
.build();

Expand Down
2 changes: 1 addition & 1 deletion examples/snippets/postDesignDocsQueries/example_request.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
.build();
AllDocsQuery query2 = new AllDocsQuery.Builder()
.inclusiveEnd(true)
.key("_design/allusers")
.startKey("_design/allusers")
.skip(1)
.build();

Expand Down
2 changes: 1 addition & 1 deletion examples/snippets/postFind/example_request_for_text_index_type.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Map<String, Object> selector = Collections.singletonMap(
"address",
Collections.singletonMap("$regex", "Street"));
Collections.singletonMap("$exists", true));

PostFindOptions findOptions = new PostFindOptions.Builder()
.db("users")
Expand Down