Skip to content

Commit

Permalink
Rephrase displayMode description to be clearer (#648)
Browse files Browse the repository at this point in the history
* Clarify meaning of true and false
* Clarify inline vs. block
  • Loading branch information
tabatkins authored and edemaine committed Apr 27, 2017
1 parent 429c1f6 commit b9e7b68
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/Settings.js
Expand Up @@ -9,8 +9,11 @@ const utils = require("./utils");
* The main Settings object
*
* The current options stored are:
* - displayMode: Whether the expression should be typeset by default in
* textstyle or displaystyle (default false)
* - displayMode: Whether the expression should be typeset as inline math
* (false, the default), meaning that the math starts in
* \textstyle and is placed in an inline-block); or as display
* math (true), meaning that the math starts in \displaystyle
* and is placed in a block with vertical margin.
*/
function Settings(options) {
// allow null options
Expand Down

0 comments on commit b9e7b68

Please sign in to comment.