From 2950d507b997312cb990a9ab2f8e5007df74e529 Mon Sep 17 00:00:00 2001 From: Lalith Suresh Date: Wed, 7 Jul 2021 15:14:32 -0700 Subject: [PATCH] docs: refresh README.md, references.md; update verify_docs script Signed-off-by: Lalith Suresh --- README.md | 3 --- docs/reference.md | 3 ++- verify_docs.sh | 3 +++ 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 64d63513..7c04e280 100644 --- a/README.md +++ b/README.md @@ -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 column = model.solve("TASKS") .map(e -> e.get("CONTROLLABLE__WORKER_ID", Integer.class)); diff --git a/docs/reference.md b/docs/reference.md index 99d70285..b2fec511 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -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: - + ```java switch (solverToUse) { case "ORTOOLS": @@ -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). diff --git a/verify_docs.sh b/verify_docs.sh index 5f89bfee..68b9afac 100644 --- a/verify_docs.sh +++ b/verify_docs.sh @@ -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