Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

Commit

Permalink
docs: refresh README.md, references.md; update verify_docs script
Browse files Browse the repository at this point in the history
Signed-off-by: Lalith Suresh <[email protected]>
  • Loading branch information
lalithsuresh committed Jul 7, 2021
1 parent 5c0b29e commit 2950d50
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,6 @@ public class QuickStartTest {
// Create a DCM model using the database connection and the above constraint
final Model model = Model.build(conn, List.of(constraint));

// Sync the model with the current data in the database
model.updateData();

// Solve and return the tasks table. The controllable__worker_id column will either be [1, 5] or [5, 1]
final List<Integer> column = model.solve("TASKS")
.map(e -> e.get("CONTROLLABLE__WORKER_ID", Integer.class));
Expand Down
3 changes: 2 additions & 1 deletion docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ is a single SQL view. See the section below on [writing constraints](#writing-co
the solver's properties (such as the timeout to use). If you omit the argument, an instance of the `OrToolsSolver`
is used. Here's an example of this API's use in our Kubernetes scheduler:

<!-- embedme ../k8s-scheduler/src/main/java/com/vmware/dcm/Scheduler.java#L179-L192 -->
<!-- embedme ../k8s-scheduler/src/main/java/com/vmware/dcm/Scheduler.java#L188-L202 -->
```java
switch (solverToUse) {
case "ORTOOLS":
Expand All @@ -60,6 +60,7 @@ is used. Here's an example of this API's use in our Kubernetes scheduler:
return Model.build(conn, solver, policies);
default:
throw new IllegalArgumentException(solverToUse);
}
```
To see all the configuration parameters for an `OrToolsSolver` instance, see the
[OrToolsSolverBuilder Javadocs](https://javadoc.io/doc/com.vmware.dcm/dcm/latest/com/vmware/dcm/backend/ortools/OrToolsSolver.Builder.html).
Expand Down
3 changes: 3 additions & 0 deletions verify_docs.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
#!/bin/bash

set -e

npx embedme README.md --verify
npx embedme docs/tutorial.md --verify
npx embedme docs/reference.md --verify

0 comments on commit 2950d50

Please sign in to comment.