DQA changes

WolframResearch · Sep 4, 2019 · 8e9bc6a · 8e9bc6a
1 parent 4fe2539
commit 8e9bc6a
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # wolfram-notebook-embedder
 
-A library to embed [Wolfram Cloud](https://www.wolframcloud.com/) notebooks on other sites. It does *not* use an `<iframe>`, but renders a notebook directly into a given DOM node for a more seamless experience.
+A library to embed [Wolfram Cloud](https://www.wolframcloud.com/) notebooks on other sites. It does *not* use an `<iframe>` but renders a notebook directly into a given DOM node, for a more seamless experience.
 
 ## Installation
 

diff --git a/docs/LibraryInterface.md b/docs/LibraryInterface.md
@@ -20,7 +20,7 @@ The following attributes can be given:
 * `allowInteract`: whether to enable interactivity in the notebook, which might use the server-side Wolfram Engine for computations; even if this is set to `true` (the default), the `Permissions` of the cloud notebook must also include `All -> {"React", "Interact"}` for interactions to actually work
 * `showRenderProgress`: whether to show the render progress indicator at the top of the notebook during the initial loading phase (see [Notebook Loading Phases](./NotebookLoadingPhases.md) for more information); the default is `true`
 
-If the notebook exceeds the given width or height, scrollbars are introduced in that dimension. The default dimensions (`width: null`, `maxHeight: Infinity`) let the notebook adapt to the container node's width (line-wrapping as necessary) and make the container node grow vertically as necessary, so there won't be a vertical scrollbar, and there will only be a horizontal scrollbar if the notebook's contents are inherently wider than the available width (e.g. a graphic with a fixed size). In the case of `maxHeight: null`, the notebook's background will fill out the whole container node even if the notebook content is smaller.
+If the notebook exceeds the given width or height, scrollbars are introduced in that dimension. The default dimensions (`width: null`, `maxHeight: Infinity`) let the notebook adapt to the container node's width (line-wrapping as necessary) and make the container node grow vertically as necessary, so there will not be a vertical scrollbar, and there will only be a horizontal scrollbar if the notebook's contents are inherently wider than the available width (e.g. a graphic with a fixed size). In the case of `maxHeight: null`, the notebook's background will fill out the whole container node even if the notebook content is smaller.
 
 The embedded notebook needs to be public (i.e. with [Permissions](https://reference.wolfram.com/language/ref/Permissions.html) of at least `All->"Read"`). For interactivity to work, the `"Interact"` permission is needed.
 

diff --git a/docs/NotebookAPI.md b/docs/NotebookAPI.md
@@ -346,12 +346,12 @@ Example response:
 
 #### getDynamicModuleVariable
 
-Retrieves the value of a DynamicModule variable.
+Retrieves the value of a [DynamicModule](https://reference.wolfram.com/language/ref/DynamicModule.html) variable.
 
 + Parameters
 
-    + `cellId` (`string`) — ID of the cell that contains the DynamicModuleBox. If the cell contains multiple DynamicModuleBoxes, the first DynamicModuleBox in a breadth-first search is chosen.
-    + `name` (`string`) — Name of the DynamicModule variable to retrieve.
+    + `cellId` (`string`) — ID of the cell that contains the `DynamicModuleBox`. If the cell contains more than one `DynamicModuleBox`, the first `DynamicModuleBox` in a breadth-first search is chosen.
+    + `name` (`string`) — Name of the `DynamicModule` variable to retrieve.
 
 + Response
 
@@ -360,24 +360,24 @@ Retrieves the value of a DynamicModule variable.
 + Errors
 
     + `"CellNotFound"` — The specified cell does not exist.
-    + `"NoDynamicModule"` — There is no DynamicModuleBox in the specified cell.
-    + `"UnknownVariableName"` — The DynamicModuleBox does not contain the specified variable.
+    + `"NoDynamicModule"` — There is no `DynamicModuleBox` in the specified cell.
+    + `"UnknownVariableName"` — The `DynamicModuleBox` does not contain the specified variable.
 
 #### setDynamicModuleVariable
 
-Sets the value of a DynamicModule variable.
+Sets the value of a [DynamicModule](https://reference.wolfram.com/language/ref/DynamicModule.html) variable.
 
 + Parameters
 
-    + `cellId` (`string`) — ID of the cell that contains the DynamicModuleBox. If the cell contains multiple DynamicModuleBoxes, the first DynamicModuleBox in a breadth-first search is chosen.
+    + `cellId` (`string`) — ID of the cell that contains the `DynamicModuleBox`. If the cell contains more than one `DynamicModuleBox`, the first `DynamicModuleBox` in a breadth-first search is chosen.
     + `name` (`string`) — Name of the DynamicModule variable to change.
     + `value` — The new value of the variable in JSON expression representation (see below).
 
 + Errors
 
     + `"CellNotFound"` — The specified cell does not exist.
-    + `"NoDynamicModule"` — There is no DynamicModuleBox in the specified cell.
-    + `"UnknownVariableName"` — The DynamicModuleBox does not contain the specified variable.
+    + `"NoDynamicModule"` — There is no `DynamicModuleBox` in the specified cell.
+    + `"UnknownVariableName"` — The `DynamicModuleBox` does not contain the specified variable.
 
 ### Cell rendering
 
@@ -455,7 +455,7 @@ Currently, only one kernel evaluation can happen at any time. However, this migh
 
 + Fields
 
-    + `isCellEvaluation` (`boolean`) — `true` if the evaluation is a whole-cell evaluation (e.g. from pressing Shift-Enter). `false` if the evaluation is triggered by a `Dynamic` or some other dynamic control (e.g. a `Button`).
+    + `isCellEvaluation` (`boolean`) — `true` if the evaluation is a whole-cell evaluation (e.g. from pressing Shift+Enter). `false` if the evaluation is triggered by a `Dynamic` or some other dynamic control (e.g. a `Button`).
 
 #### evaluation-stop
 

diff --git a/docs/NotebookLoadingPhases.md b/docs/NotebookLoadingPhases.md
@@ -21,6 +21,6 @@ If no static HTML is available for the notebook as a whole or for individual cel
 By default, notebooks show a (blue) progress indicator at the top during the initial render phase. It can be turned off by setting the option `showRenderProgress: false`. The progress indicator distinguishes between two groups of phases:
 
 1. (Phases 1–3 above.) An indeterminate progress indicator is shown.
-2. (Phases 4–6 above.) A determinate progress indicator is shown, based on the number of rendered vs. total cells, as long as there are at least three cells in the notebook. If there are fewer then three cells, another indeterminate progress indicator is shown (since a determinate progress indicator would jump too much and not give a real impression of progress).
+2. (Phases 4–6 above.) A determinate progress indicator is shown, based on the number of rendered vs. total cells, as long as there are at least three cells in the notebook. If there are fewer than three cells, another indeterminate progress indicator is shown (since a determinate progress indicator would jump too much and not give a real impression of progress).
 
 Once the initial render phase is over, the progress indicator is hidden.